Skip to main content

List payment instruments

Lists all payment instrument resources that are saved for an identified customer.

Responses

OK


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 string

    Possible values: >= 4 characters and <= 4 characters

    Last 4 digits of the payment card number.

  • type string

    Possible 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 string

    Indicates the mandate type

  • status string

    Mandate status

  • merchant_code string

    Merchant 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.