Skip to main content
POST
Cancel a payment that has not reached the bank

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

payment_id
string<uuid>
required

The payment to cancel.

Body

application/json

Optional body for POST /v1/platform/payments/{payment_id}/cancel.

reason
string | null

Why you are cancelling, for your own records and ours. Optional.

Maximum string length: 255
Example:

"Customer asked to hold the payment"

Response

Payment cancelled

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.