List payment instruments
Lists all payment instrument resources that are saved for an identified customer.
- 200
- 401
- 403
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema array
- token string
Unique token identifying the saved payment card for a customer.
- active boolean
Default value:
true
Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a
DELETE
request to the resource endpoint. - type string
Possible values: [
card
]Type of the payment instrument.
card object
Details of the payment card.
last_4_digits stringPossible values:
>= 4 characters
and<= 4 characters
Last 4 digits of the payment card number.
type stringPossible values: [
AMEX
,CUP
,DINERS
,DISCOVER
,ELO
,ELV
,HIPERCARD
,JCB
,MAESTRO
,MASTERCARD
,VISA
,VISA_ELECTRON
,VISA_VPAY
,UNKNOWN
]Issuing card network of the payment card.
mandate object
Created mandate
type stringIndicates the mandate type
status stringMandate status
merchant_code stringMerchant code which has the mandate
- created_at date-time
Creation date of payment instrument. Response format expressed according to <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener">ISO8601</a> code.
[
{
"token": "string",
"active": true,
"type": "card",
"card": {
"last_4_digits": "string",
"type": "AMEX"
},
"mandate": {
"type": "string",
"status": "string",
"merchant_code": "string"
},
"created_at": "2023-02-01"
}
]
Unauthorized
- application/json
- Schema
- Example (from schema)
- Invalid_ Token
- Not_ Authorized_ Token
- Missing_ Token
Schema
- message string
Short description of the error.
- error_code string
Platform code for the error.
{
"message": "string",
"error_code": "string"
}
{
"error_message": "invalid access token",
"error_code": "NOT_AUTHORIZED"
}
{
"error_message": "NOT_AUTHORIZED",
"error_code": "NOT_AUTHORIZED"
}
{
"message": "access token required",
"error_code": "NOT_AUTHORIZED"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Forbidden
Schema
- error_message string
Short description of the error.
- error_code string
Platform code for the error.
- status_code string
HTTP status code for the error.
{
"error_message": "string",
"error_code": "string",
"status_code": "string"
}
{
"error_message": "request_not_allowed",
"error_code": "FORBIDDEN",
"status_code": 403
}
Not Found
- application/json
- Schema
- Example (from schema)
- Not_ Found
Schema
- message string
Short description of the error.
- error_code string
Platform code for the error.
{
"message": "string",
"error_code": "string"
}
{
"error_code": "NOT_FOUND",
"message": "Resource not found"
}