Initiate a Payin Reversal

This endpoint reverses a previously received payin.

Important Information:

  • This is not a scheme-based reversal; it is treated as a regular payout, and payout charges apply.
  • Payin reversal can be initiated only on accounts where the permission flag pi_reversal_enabled is set to true.
  • Reversal currency and account details must exactly match those of the original payin transaction.
  • The reversal amount cannot exceed the amount of the parent transaction.
  • When reversing a payin due to failed reconciliation or an order cancellation, you can skip recipient registration entirely.
📘

Webhook

The webhook payload for payin reversals is identical to the payout webhook, with these key fields to identify a reversal and link back to the original transaction:

"event": "PAYOUT"
"payment_type": "payout"
"type_description": "payin_reversal"
"parent_transaction_id": "59b69a52-7748-42ef-9a8b-48fc05f9a9f5"
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Merge UUID of the account that received the original payin.

Body Params
string
required

Amount to be reversed.

string
required

Must match the original payin’s source_currency, following the three-letter ISO 4217 code.

string
required

Must match the original payin’s source_name.

string
required

ID of the payin transaction to reverse.

string

Must match the original payin’s source_account_number. Required when currency is GBP.

string

Must match the original payin’s source_sort_code. Required when currency is GBP.

string

Must match the original payin’s source_iban. Required when currency is EUR.

string

Must match the original payin’s source_bic.

string
required

Payout reference on the statement. GBP: 6–18 chars; EUR: 6–140 chars. Allowed: A–Z, a–z, 0–9, space, &, -, ., /.

string

Reference in the client’s system.

string
enum
required

Reason for the reversal.

Allowed:
string

Idempotency key; client-generated.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json