Get Payment Options
This API method enables you to retrieve the list of the payment options stored under a specific private or business consumer's account.
API Response Parameters
| Parameter | Description | Type |
|---|---|---|
| name | Name of the payment option returned. | String |
| code | Code of the payment option returned. | String |
| carrierNumber | Masked number of the payment option. | String |
| reference | Payment option ID. | String |
| isDefault | Specifies if the payment option is marked as 'default', which requires it to be preselected. | Boolean |
| isExpired | Denotes if the payment option has expired. | Boolean |
| expiresSoon | Denotes if the payment option expires soon. | Boolean |
| expiryDate | Date when the payment option will expire. | MM/YYYY |
Get Payment Options Example - SEPA and Cards
SEPA Response Parameters
info
The Get Payment Options API provides a response containing a variety of parameters that may change depending on the selected payment method. Each payment option can have distinct fields, and understanding these variations is essential for proper integration. On the distinct payment option pages, we provide a detailed overview of the key parameters, descriptions and their data types.
Please refer to the SEPA page.
Request
Path:
{Base URL}/accounts/{customerAccountId}/paymentOptions
Header:
Content-Type: application/json
Accept-Language: en-US
Response
Status Code:
200 (OK)
Header:
Content-Type: application/json
Accept-Language: en-US
{
"result": [
{
"name": "Mastercard",
"code": "MSTRCRD",
"carrierNumber": "520000****0106",
"reference": "8ac7a4a08c13ee65018c151c330a26c6",
"isDefault": true,
"isExpired": false,
"expiresSoon": false,
"expiryDate": "03/2025"
},
{
"name": "Bank Account",
"code": "BNKACCT",
"carrierNumber": "DE8937****3000",
"reference": "05d985b8a7864e9ca71067dc98da5f99",
"isDefault": true,
"isExpired": false,
"expiresSoon": false,
"expiryDate": "12/2999",
"storedPaymentOptionData": {
"mandate": {
"mandateReference": "SEPA-202430071-NLD7GT499684QMHJ47S4",
"mandateSignedDate": "2024-09-24",
"mandateSignedTime": "000000"
},
"bankCode": "COBADEFFXXX",
"bankName": "ACME Bank"
}
},
{
"name": "SEPA Direct Debit B2B",
"code": "SEPADDB2B",
"carrierNumber": "DE******",
"reference": "U861vQBGPgSn8iPeNfGH5",
"isDefault": false,
"isExpired": false,
"expiresSoon": false,
"expiryDate": "12/2999",
"additionalData": [
{
"name": "dd.creditorName",
"value": "J.P. Morgan Mobility Payments Solutions"
},
{
"name": "dd.creditorIdentifier",
"value": "LU11ZZ***01491"
},
{
"name": "dd.creditorAddressCity",
"value": "Munich"
},
{
"name": "dd.creditorAddressCountryCode",
"value": "DE"
},
{
"name": "dd.creditorAddressNumber",
"value": "456"
},
{
"name": "dd.creditorAddressLine1",
"value": "Leopoldstr."
},
{
"name": "dd.creditorPostCode",
"value": "80807"
},
{
"name": "dd.mandateStatus",
"value": "ACTIVE"
},
{
"name": "dd.mandateReference",
"value": "HM3BY4***SQDXYZD5"
},
{
"name": "dd.mandateDateOfSignature",
"value": "2021-02-23"
},
{
"name": "dd.mandateId",
"value": "224e1e25-12d5-4015-8d18-64383a14d50e"
},
{
"name": "dd.mandateVersionTag",
"value": "0001"
},
{
"name": "dd.debtorBankName",
"value": "Banca Frencesa new"
},
{
"name": "dd.debtorBankBic",
"value": "PSSTFRPPNEW"
}
]
}
{
"name": "SEPA Direct Debit core",
"code": "SEPADDCORE",
"carrierNumber": "BE6853****7034",
"reference": "nuhMFZI81bpqkkwJmDPuF",
"isDefault": false,
"isExpired": false,
"expiresSoon": false,
"expiryDate": "12/2999",
"storedPaymentOptionData": {
"bankCode": "EXBKDE81XXX",
"bankName": "ACME Bank"
},
"additionalData": [
{
"name": "dd.creditorName",
"value": "J.P. Morgan Mobility Payments Solutions"
},
{
"name": "dd.creditorIdentifier",
"value": "LU11ZZ***001491"
},
{
"name": "dd.creditorAddressCity",
"value": "Munich"
},
{
"name": "dd.creditorAddressCountryCode",
"value": "DE"
},
{
"name": "dd.creditorAddressNumber",
"value": "456"
},
{
"name": "dd.creditorAddressLine1",
"value": "Leopoldstr."
},
{
"name": "dd.creditorPostCode",
"value": "80807"
},
{
"name": "dd.mandateStatus",
"value": "ACTIVE"
},
{
"name": "dd.mandateReference",
"value": "HM3BY***YZD5"
},
{
"name": "dd.mandateDateOfSignature",
"value": "2021-02-23"
},
{
"name": "dd.mandateId",
"value": "224e1e25-12d5-4015-8d18-64383a14d50e"
},
{
"name": "dd.mandateVersionTag",
"value": "0001"
},
{
"name": "dd.debtorBankName",
"value": "Banca Frencesa new"
},
{
"name": "dd.debtorBankBic",
"value": "PSSTFRPPNEW"
}
]
}
]
}
Get Payment Options Example - Bacs
Bacs Response Parameters
info
The Get Payment Options API provides a response containing a variety of parameters that may change depending on the selected payment method. Each payment option can have distinct fields, and understanding these variations is essential for proper integration. On the distinct payment option pages, we provide a detailed overview of the key parameters, descriptions and their data types.
Please refer to the Bacs page.
Request
Path:
{Base URL}/accounts/{customerAccountId}/paymentOptions
Header:
Content-Type: application/json
Accept-Language: en-US
Response
Status Code:
200 (OK)
Header:
Content-Type: application/json
Accept-Language: en-US
{
"result": {
"name": "BACS Direct Debit",
"code": "BACSDD",
"carrierNumber": "1234****",
"reference": "YSPO5R...9AHoWNzn",
"isDefault": false,
"isExpired": false,
"expiresSoon": false,
"expiryDate": "12/2999",
"storedPaymentOptionData": {
"bankCode": "500000",
"bankName": "ACME Bank"
},
"additionalData": [
{
"name": "dd.mandateStatus",
"value": "ENABLED"
},
{
"name": "dd.mandateReference",
"value": "BACS20240515jf56iJ"
}, {
"name": "dd.mandateInitiationDate",
"value": "15-15-2024"
},
{
"name": "dd.mandateActivationDate",
"value": "21-05-2024"
},
{
"name": "dd.creditorId",
"value": "44556677889900"
},
{
"name": "dd.bacsMerchantName",
"value": "J.P. Morgan Mobility Payments Solutions S.A_GBP"
},
{
"name": "dd.bacsMerchantMandateLabel ",
"value": "JPM_GBP "
}
]
}
}