TRtruelayer
Payments

Cancel payment

Cancel a payment

This API can be called:

  • using the resource_token associated with the payment you are trying to fetch;
  • using a backend bearer token.
post/v3/payments/{id}/actions/cancel

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/payments/{id}/actions/cancel
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.truelayer.com/connect/token scopes: payments
    • or HTTP bearer

Path parameters

idstring required

Unique ID for the Payment

Example:0afd1f6a-f611-48ce-9488-321129bb3a70

ID of the payment

Headers

Idempotency-Keystring required

An idempotency key to allow safe retrying without the operation being performed multiple times. The value should be unique for each operation, e.g. a UUID, with the same key being sent on a retry of the same request.

Tl-Signaturestring required

A JWS with detached content, signed with your private key. See Request Signing

Response

Accepted

Changes

No recorded changes to this operation across all 1 revision of this API.