Online Payments

Sub-merchant support

For clients who aggregate transactions submitted to J.P. Morgan on behalf of multiple merchants (sub-merchants), we provide the means to send sub-merchant identifying fields as required by the card brands. This can be accomplished by sending soft merchant data and sub-merchant data fields in your API request to identify the sub-merchant.

Attention

You must complete additional setup with us to activate soft merchant data and sub-merchant data features. As a new client, contact your sales representative. For existing clients, contact your relationship manager.

To identify your sub-merchant, submit the following fields:

merchant.merchantCategoryCode - Populate the MCC of your sub-merchant.
subMerchantSupplementalData.merchantIdentification.subMerchantId - Generate a unique value to identify your sub-merchant.
subMerchantSupplementalData.merchantIdentification.serviceEntitlementNumber - Assigned by the payment brand.
subMerchantSupplementalData.merchantIdentification.sellerIdentifier - Assigned by us to process American Express. This is used for American Express Opt Blue merchants.

Tip

If you want to see your subMerchantId on reporting, it should be populated in the first portion of the merchantOrderNumber. Keep in mind that the max length of the merchant order number is 22 characters. If the merchant order number length is greater than 22, we truncate from the left.

For aggregators, American Express transactions require the following fields:

merchant.merchantCategoryCode
merchant.softMerchant.name
merchant.softMerchant.phone
merchant.softMerchant.email
merchant.softMerchant.address.line1
merchant.softMerchant.address.city
merchant.softMerchant.address.state
merchant.softMerchant.address.postalCode
merchant.softMerchant.address.countryCode
subMerchantSupplementalData.merchantIdentification.sellerIdentifier – Required for Amex Blue Merchants
subMerchantSupplementalData.merchantIdentification.sellerIdentifier
subMerchantSupplementalData.merchantIdentification.serviceEntitlementNumber

For other card brands the subMerchantID is required.

Attention

The foreignMerchantIndicator value is not carried over between requests.

If captureMethod = MANUAL and it needs to affect settlement, include it in both the authorization and the capture.
If captureMethod = NOW, including it in the authorization is enough.

The following is an example of all sub-merchant and soft merchant data fields:

Json

{
        "merchantCategoryCode": 8398,
        "softMerchant": {
            "visaMerchantVerificationValueId": "123",
            "masterCardMerchantVerificationValueId": "123",
            "merchantIncorporationStatus": "6",
            "foreignMerchantIndicator": true,
            "name": "DoggieDaycare Boarding",
            "phone": "877-777-7777",
            "email": "example@example.com",
            "url": "softmerchanturl",
            "address": {
                "line1": "252 Walkabout Road",
                "line2": "Suite 252",
                "city": "Blue",
                "state": "FL",
                "postalCode": "33333",
                "countryCode": "USA"
            }
        }
    },
    "subMerchantSupplementalData": {
        "merchantIdentification": {
            "sellerIdentifier": "123",
            "serviceEntitlementNumber": "1234",
            "subMerchantId": "abc123"
        }
    }
}