PUT/api/v2/payments/requests/{requestId}/cancel

Cancel a payment request

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
requestId (path)	unknown	Yes	Payment request ID

Request body

application/json

Request body fields
Field	Type	Required	Description
Reason	string	No

Responses

200 — OK

Response 200 fields
Field	Type	Required
Id	unknown	No
UserId	unknown	No
CompanyId	unknown	No
Amount	string	No
Currency	string	No
Status	PaymentStatusV2	No
Description	string	No
ExternalReferenceId	string	No
CallbackUrl	string	No
SuccessUrl	string	No
FailureUrl	string	No
PaymentUrl	string	No
CreatedAt	string	No
UpdatedAt	string	No
CompletedAt	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X PUT "https://{base_url}/api/v2/payments/requests/{requestId}/cancel" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.