Get Payment Option

GET 
/accounts/:customerAccountId/paymentOptions/:storedPaymentOptionReference

Retrieves a specific payment option identified by the reference parameter. This endpoint is useful when only a single payment option needs to be queried, without fetching all stored options.

Request

Path Parameters

customerAccountId stringrequired
Possible values: <= 255 characters
Customer identifier
Example: john_doe_12345
storedPaymentOptionReference stringrequired

Unique identifier for the stored payment option to be retrieved

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

Responses

200

Payment option successfully retrieved.

application/json

Schema

Schema

result object[]
List of one payment option object matching the reference.
Array [
namestring
Name of the payment option provider (e.g., Visa, Mastercard, PayPal).
Possible values: <= 128 characters
Example: Mastercard
codestring
Internal payment option code identifying the payment method type.
Possible values: <= 32 characters, [AMEX, BNKACCT, CRTBANCAIR, DISCOVER, GIROPAY, IDEAL, JCB, MSTRCRD, MSTRO, PAYPAL, PAYU, PAYUBLK, PAYUTWST, PAYUINST, PREPMNT, SEPADDB2B, SEPADDCORE, VISA, VISADBIT]
Example: MSTRCRD
carrierNumberstringnullable
Masked card number or account identifier (e.g., IBAN, card PAN).
Possible values: <= 32 characters
Example: 520000****0106
referencestring
Unique reference ID of the stored payment option.
Possible values: <= 64 characters
Example: 8ac7a4a08c13ee65018c151c330a26c6
isDefaultboolean
Indicates whether this is the default payment option for the account.
Example: true
isExpiredboolean
Indicates whether the payment option is expired.
Example: false
expiresSoonboolean
Indicates whether the payment option is approaching expiry.
Example: false
expiryDatestringnullable
Expiration date of the payment option if applicable.
Possible values: <= 7 characters, Value must match regular expression MM/yyyy
Example: 03/2025
]

Example (auto)

{
  "result": [
    {
      "name": "Mastercard",
      "code": "MSTRCRD",
      "carrierNumber": "520000****0106",
      "reference": "8ac7a4a08c13ee65018c151c330a26c6",
      "isDefault": true,
      "isExpired": false,
      "expiresSoon": false,
      "expiryDate": "03/2025"
    }
  ]
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}