Cancel Payment

Cancels an existing payment instruction. Only payments in PENDING or FAILED status can be cancelled.

POST /payments/payments/cancel

Body parameters - Request

Name	Type	Description	Required
id	string	The payment request ID to be cancelled	Yes
cancel_reason	string	A reason for the cancellation

Body parameters - Response

Name	Type	Description
id	string	Unique payment identifier
correlation_id	string	External tracking identifier
purpose	string	4-letter ISO-20022 payment purpose code
source.type / source.id	string	Entity type and ID that originated the payment
target.type / target.id	string	Entity type and ID of the payment recipient
info.status	boolean	Payment status
info.funding	object	Funding currency and amount
info.credit	object	Credited currency and amount
info.error	object	Error details if applicable
amount.type	string	LAND or SEND — whether amount represents credited or debited funds
amount.amount	number	Payment value
amount.currency	string	3-letter ISO currency code
execution.date	DateTime	Scheduled payment execution date
final.is_final	boolean	Indicates whether the amount is final
attachments	array	List of attached documents
approved	boolean	Whether the payment was approved prior to cancellation
user_tags	object	Custom key/value tags associated with the payment

Request Example

POST /payments/payments
{
    "id": "b5f5433f-1ede-4623-9e3e-9282b13b7e8b",
    "cancel_reason": "Beneficiary has pending to update bank details."
}

Response Examples

200 - OK Success

{
    "id": "507013::e0132a41-aadc-4eb9-bb9a-3341e542333e::b5f5433f-1ede-4623-9e3e-9282b13b7e8b",
    "correlation_id": "b5f5433f-1ede-4623-9e3e-9282b13b7e8b",
    "purpose": "OTHR",
    "source": {
      "id": "92f8232f-8481-4631-a6d0-cb4a35cce294",
      "type": "group"
    },
    "target": {
      "type": "contact",
      "id": "e0132a41-aadc-4eb9-bb9a-3341e542333e"
    },
    "info": {
      "funding": {
        "currency": "INR",
        "amount": 9876.00000
      },
      "status": "CANCELLED",
      "error": {},
      "credit": {
        "currency": "GBP",
        "amount": 78.73002
      }
    },
    "amount": {
      "type": "LAND",
      "amount": 9876.00,
      "currency": "INR"
    },
    "execution": {
      "date": "2026-03-30T01:00:00Z"
    },
    "final": {
      "is_final": true
    },
    "attachments": [],
    "approved": true,
    "user_tags": {
      "Business": "B2B",
      "Country": "Poland"
    }
  }

400 - Bad Request

 {
    "error": "bad_request",
    "description": "Schema validation failed: Validation errors: {\"org_id\":\"265030\"}",
    "error_code": 400
  }

404 - Not Found

 {
    "error": "bad_request",
    "description": "Schema validation failed: Validation errors: {\"org_id\":\"265030\"}",
    "error_code": 400
  }

409 - Conflict

{
    "error": "Cancel Failed",
    "description": "Cancel Failed",
    "error_code": 409
  }