Return a payment

Return a payment

SecurityoAuth2
Request
path Parameters
paymentUID
required
string

Payment Unique Identifier. Return payment functionality is applicable only for incoming payments and payment status should be 'Processed'.

Request Body schema: application/json
achReturnCode
string

If the payment type is ACH then the achReturnCode is mandatory and valid ACH return code such as R01,R02 etc.

returnNotes
string

If the payment type is FEDWIRE then the 'returnNotes' is mandatory.

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}/return
Request samples
application/json
{
  • "achReturnCode": "R01",
  • "returnNotes": "Invalid payment request."
}
Response samples
application/json
[
  • {
    }
]