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

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

returnCode
string

If the payment type is FEDWIRE, then 'returnCode' is mandatory. For ACH payments, use 'returnCode' instead of 'achReturnCode'. All validations for ACH and FEDWIRE return codes are now handled through this field.

Enum: "AC01" "AC03" "AC04" "AC06" "AC14" "DUPL" "AM06" "AM09" "BE05" "BE06" "CUST" "FOCR" "FR01" "MS02" "MS03" "NARR" "RR01" "RR02" "RR03" "RR04" "RUTA" "UPAY"
returnNotes
string

If the payment type is FEDWIRE, returnNotes is required. If the payment type is RTP and returnNotes is not provided, it defaults to Customer Initiated.

returnType
string

Applicable only for RTP payments. This field is mandatory for RTP. Allowed values are IPAY, PECR, and RJCR.

settlementAmount
number <bigdecimal>

Applicable only for RTP payments. This field is required when returnType is PECR.

rejectReasonCode
string

Applicable only for RTP payments. This field is required when returnType is RJCR. Allowed values are AC04, AM04, ARDT, CUST, LEGL, NOAS, and NOOR.

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",
  • "returnCode": "CUST",
  • "returnNotes": "Invalid payment request.",
  • "returnType": "IPAY",
  • "settlementAmount": 4500.88,
  • "rejectReasonCode": "AM04"
}
Response samples
application/json
[
  • {
    }
]