Skip to content
/
Payment Cancel

Payment Cancel

Request

Cancel a payment held for compliance review: pending, with msg AML Pending

Security
bearerAuth
Path
idstring(Id)required
Any of:
string (uuid)
Query
countrystring(ApiCountry)required
Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
externalboolean(External)

When true, the id supplied is external_id from the original payment request.

Default:false
curl -i -X POST \
  'https://docs.swiftxpay.com/_mock/openapi/v2/payment/{id}/cancel?country=BGD&external=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)required

Payment id.

timestampstring, (date-time)(Timestamp)required

When the status changed (UTC).

statusstring(PaymentOrderState)required

The new payment state.

Enum:"queued""rejected""pending""processing""succeeded""failed""canceled""unknown""reversed"
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "timestamp": "2019-08-24T14:15:22Z",
  "status": "queued"
}