Consent Services

Get Consent Cards by Customer Reference

Changed on

Returns the active stored cards (consent / card-on-file, RN-075) associated with a customer reference.

get/v1/payment/consent/customers/{customer_reference}/cards

Request

  • Base URL
    https://api-sandbox.koin.com.br
  • URL
    https://api-sandbox.koin.com.br/v1/payment/consent/customers/{customer_reference}/cards
  • Auth
    none declared. Required headers: Content-Type, Accept

Path parameters

customer_referencestring required

Customer reference used to link the stored consent (card-on-file).

Headers

Content-Typestring required

The Media type of the body of the request. Default value for payment provider protocol is application/json

Acceptstring required

Acceptable media type(s) for the response. Default value for payment provider protocol is application/json

Response

Stored cards associated with the customer reference

instrument_tokenstring

Instrument token that identifies the stored card.

Example response

[
  {
    "instrument_token": "4f3c2b1a-9d8e-4a7b-8c6d-1e2f3a4b5c6d",
    "card": {
      "bin": "411111",
      "type": "CREDIT",
      "brand": {
        "name": "VISA"
      }
    }
  }
]

Changes