Skip to main content

Payment methods

Consumer profiles allow you to store and manage multiple payment methods for a consumer. This allows you to perform seamless payment transactions without the need to store the payment method details in your system.

The following payment methods are supported by Consumer Profile Management API.

Supported payment methods
Payment methods Supported regions Supported currencies Supported brands Description
Cards (credit/debit)
  • United States (US)
  • European Union (EU)
  • Canada (CA)
  • Australia (AU)
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STN, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW
  • Visa
  • Mastercard
  • Amex
  • Discover
  • Discover Diners
  • JCB
  • Maestro
 Consumer's credit/debit payment methods are saved for future use.
Electronic Check Processing (ECP, eCheck, or US ACH) United States (US) USD N/A
  • eCheck payments are processed through the ACH Network and regulated by the National Automated Clearing House Association (NACHA).
  • J.P. Morgan collects the bank account number, routing number, name, and address of the account.

SEPA 

 Europe

EUR

 N/A Single Euro Payments Area (SEPA) Direct Debit is an European bank-to-bank transfer method that allows you to collect payments directly from consumer accounts. Consumers accept SDD mandate to complete payment using IBAN account number & Bank Identifier Code (BIC) from their Euro-denominated account.
Note

You must provide a method of payment when creating a consumer profile or the request will fail.

If you provide more than one method of payment and a default method of payment is not selected:

  • Card will be selected as the default. 
  • If card is not provided, ACH will be selected as the default.
  • If card and ACH is not provided, SEPA will be selected as the default.

Add payment method to consumer profile

You can add a new payment method to an existing consumer profile by sending a POST request to the /consumer-profiles/{consumer-profile-id}/payment-methods endpoint.

HTTP method: POST

Endpoint: /consumer-profiles/PACJGQ/payment-methods

Scenario: Adding a new payment method to consumer profile with consumer-profile-id = PACJGQ

Json
{
    "cardList": [
        {
            "cardExpirationMonthYearNumber": "02/2025",
            "accountNumber": "4234555678990919",
            "accountStatus": "ACTIVE",
            "cardType": "DI",
            "firstName": "John",
            "lastName": "Doe",
            "consumerProfileAddress": {
                "firstName": "John",
                "lastName": "Doe",
                "consumerAssignedAddressName": "Work",
                "primaryAddressIndicator": true,
                "addressType": "SHIPPING",
                "line1": "400 Elton Farm",
                "line2": "Apt 123",
                "city": "Glen Mills",
                "state": "PA",
                "postalCode": "19342",
                "countryCode": "USA",
                "addressStatus": "ACTIVE"
            }
        }
    ]
}

Response:

Json
{
    "consumerProfileId": "PACJGQ",
    "cardOnFileReferenceNumber": "123",
    "firstName": "John",
    "lastName": "Doe",
    "communication": {
        "phoneList": [
            {
                "phoneNumber": "8888888828",
                "countryCode": "1",
                "phoneNumberType": "Home",
                "communicationIdentifier": "HH04423498968"
            }
        ],
        "emailList": [
            {
                "emailAddress": "john.doe.x@gmail.com",
                "emailAddressType": "Home",
                "communicationIdentifier": "EE8141240230923"
            }
        ]
    },
    "paymentMethodType": {
        "cardList": [
            {
                "paymentMethodId": "77ccba29-4857-494a-82bc-2a80e1fa2b9d",
                "cardExpirationMonthYearNumber": "01/2025",
                "last4CardNumber": "9999",
                "accountStatus": "ACTIVE",
                "cardType": "MC",
                "firstName": "John",
                "lastName": "Doe",
                "addressIdentifier": "8d452494-ec75-4ef9-9b45-e4bd7debf6a0"
            },
            {
                "paymentMethodId": "63aaba29-4857-494a-82bc-2a80e1fa2b1e",
                "cardExpirationMonthYearNumber": "02/2025",
                "last4CardNumber": "0919",
                "accountStatus": "ACTIVE",
                "cardType": "DI",
                "firstName": "John",
                "lastName": "Doe",
                "addressIdentifier": "e17a1ecd-b177-4c3d-a99b-c72e132b260f"
            }
        ]
    },
    "addresses": [
        {
            "addressIdentifier": "8d452494-ec75-4ef9-9b45-e4bd7debf6a0",
            "firstName": "John",
            "lastName": "Doe",
            "consumerAssignedAddressName": "Work",
            "primaryAddressIndicator": true,
            "addressType": "SHIPPING",
            "line1": "200 Elton Farm",
            "line2": "Apt 123",
            "city": "Glen Mills",
            "state": "PA",
            "postalCode": "19342",
            "countryCode": "USA",
            "addressStatus": "ACTIVE"
        },
        {
            "addressIdentifier": "e17a1ecd-b177-4c3d-a99b-c72e132b260f",
            "firstName": "John",
            "lastName": "Doe",
            "consumerAssignedAddressName": "Work2",
            "primaryAddressIndicator": true,
            "addressType": "SHIPPING",
            "line1": "400 Elton Farm",
            "line2": "Apt 123",
            "city": "Glen Mills",
            "state": "PA",
            "postalCode": "19342",
            "countryCode": "USA",
            "addressStatus": "ACTIVE"
        }
    ],
    "correlationIdentifier": "648ccc37-e006-45ee-a127-2718bffeadad",
    "createTimestamp": "2021-08-23T00:23:05.353Z",
    "createUserIdentifier": "jack",
    "updateTimestamp": "2024-07-02T09:38:54.781Z",
    "updateUserIdentifier": "jack",
    "profileStatus": "ACTIVE"
}

Manage payment methods for a consumer profile

You can perform the following actions to manage the payment methods on an existing consumer profile:

  1. Add a new payment method to a consumer profile
  2. Update a payment method
  3. Set the default payment method
  4. Delete a payment method

To learn more about how to manage the payment methods on a consumer profile, refer to manage payment methods for a consumer profile.

Manage consumer profile address
Manage payment method for a consumer profile
Manage communication methods for a consumer profile