Read a customer token

https://api.kustom.co/customer-token/v1/tokens/{customerToken}

Returns the status and payment method details of a customer token. Internally served by MerchantApiController’s /merchant/{merchantId}/v1/tokens/{tokenId} route, reached through MerchantRequestRewriteFilter. Merchant log action: READ_TOKEN.

Parameters

200

404

500

Example

Parameters1 field

• customerTokenstringrequiredin path

200

Response8 fields

Token was successfully read.

• cardobjectoptional
  3 fields in card

  • brandstringrequired

    Card brand.

  • expiry_datestringrequired

    Card expiration date.

  • masked_numberstringrequired

    Masked credit card number.

• direct_debitobjectoptional
  1 field in direct_debit

  • masked_numberstringrequired

    Masked bank account number.

• payment_method_typestringrequired

  Selected payment method.

• statusstringrequired

  Status of the token, e.g. ACTIVE, CANCELLED, SUSPENDED.

404

Response0 fields

The merchant is not migrated, or the token or merchant was not found.

No response body — this status returns headers only.

500

Response0 fields

An unexpected error occurred.

No response body — this status returns headers only.

GET https://api.kustom.co/customer-token/v1/tokens/{customerToken}

Response200404500

Response 200· Token was successfully read.

{
  "card": {
    "brand": "VISA",
    "expiry_date": "12/2020",
    "masked_number": "************1234"
  },
  "direct_debit": {
    "masked_number": "**********124"
  },
  "payment_method_type": "INVOICE",
  "status": "ACTIVE"
}

12 linesCopy

Response 404· The merchant is not migrated, or the token or merchant was not found.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 500· An unexpected error occurred.

No response body.

This status returns headers only — there is nothing to parse.

—