Issue a Refund

Certain rules apply to the issuance of a refund:

  • Must be applied against a successfully cleared Payment Request (Collections or Receivables)
  • Many refunds may be created against the original Payment Request
  • The total refunded amount must not exceed the original value
We now require supplying an Idempotency-Key header when performing this request to ensure you can safely retry the action in case of an issue. If the header value is different to one provided previously, we will be treating a request as a new operation which may lead to duplicate refunds. To understand more on how to make idempotent requests, please refer to our Idempotent requests guide.
Path Params
string
required

The credit reference number e.g C.625v

Body Params
integer
required
1 to 99999999999

Amount in cents refund (Min: 1 - Max: 99999999999)

channels
array

Specify the payment channel to be used, in order. (new_payments_platform, direct_entry, or both)

channels
string

The first 8 characters are visible if funds are sent via direct credit / BECS, and up to 270 characters if sent via NPP

uuid

Specify where we should take the funds for this transaction. If omitted, your primary bank account will be used.

string
Headers
string
required

Idempotency key to support safe retries for 24h

string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Response

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