Update a customer token's status

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

Cancels a customer token. Internally served by MerchantApiController’s /merchant/{merchantId}/v1/tokens/{tokenId}/status route, reached through MerchantRequestRewriteFilter. Merchant log action: UPDATE_TOKEN.

Parameters

Request body

202

400

404

500

Example

Parameters1 field

• customerTokenstringrequiredin path

Request body1 field

• statusstringrequired

  The token status to update to.

  • CANCELLED

202

Response0 fields

Token status update request has been accepted and is being processed.

No response body — this status returns headers only.

400

Response9 fields

The status field was missing, the request failed validation, or the token is not currently ACTIVE.

• authorized_payment_methodobjectoptional
  3 fields in authorized_payment_method

  • number_of_daysinteger · int32optional
  • number_of_installmentsinteger · int32optional
  • typestringrequired
    • invoice
    • fixed_amount
    • pix
    • base_account
    • deferred_interest
    • direct_debit
    • direct_bank_transfer
    • b2b_invoice
    • card
    • slice_it_by_card
    • pay_later_by_card
    • fixed_sum_credit
    • +2 more
• correlation_idstringoptional
• error_codestringoptional
• error_messages[]array<string>optional
• fraud_statusstringoptional
• reasonstringoptional

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.

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

RequestBodyResponse202400404500

Request body· application/json

{
  "status": "CANCELLED"
}

3 linesCopy

Response 202· Token status update request has been accepted and is being processed.

No response body.

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

—

Response 400· The status field was missing, the request failed validation, or the token is no…

{
  "authorized_payment_method": {
    "number_of_days": 0,
    "number_of_installments": 0,
    "type": "invoice"
  },
  "correlation_id": "<string>",
  "error_code": "BAD_VALUE",
  "error_messages": [
    "<string>"
  ],
  "fraud_status": "ACCEPTED",
  "reason": "Purchase for payment method failed"
}

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

—