Reverse a payment

Initiate a reverse payment request.

SecurityoAuth2
Request
path Parameters
paymentUID
required
string

Payment Unique Identifier. Reverse payment functionality is applicable only for outgoing credit payments and payment status should be 'Processed'. Reverse functionality is not supported for the SWIFT payment type.

Request Body schema: application/json
reversalNotes
string

Reversal notes. Optional field. For FedWire payments, if the value is not provided, a default value will be assigned by the system.

reversalCode
string

Reversal reason code. This field is mandatory only for FedWire payments. For ACH payments, this field is optional.

Enum: "AC03" "AGNT" "AM09" "CUST" "CUTA" "DUPL" "FRAD" "NARR" "TECH" "UPAY"
Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Successful

put/v3/payments/{paymentUID}/reverse
Request samples
application/json
{
  • "reversalNotes": "string",
  • "reversalCode": "CUST"
}
Response samples
application/json
[
  • {
    }
]