Return ACH RDFI transaction

post

https://devapi.qolopay.com/api/{version}/transfers/ach/return

Returns a previously received (and posted, or awaiting posting) ACH RDFI transaction.
The original transaction must have been received by Qolo as an approved RDFI ACH transaction
(request_code 'LT-DDA_IN' or 'UT-DDA_OUT'). The supplied return_code is validated against the
ACH Return Codes configurations.
currently supported return codes are: R05, R06, R07, R10, R13, R14, R15, R16, R17, R20, R29, R31.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

Request to return a previously received and posted (or awaiting posting) ACH RDFI transaction.

txn_guid

uuid | null

Original transaction reference. Either "txn_guid" or "bank_eft_guid is required.

bank_eft_guid

uuid | null

The original EFT transaction reference. Either "bank_eft_guid" or "txn_guid" is required.

return_code

string

required

length between 1 and 8

ACH return reason code (Allowed values: R05, R06, R07, R10, R13, R14, R15, R16, R17, R20, R29, R31.)

addenda_description

string

required

length between 1 and 44

Free-form addenda information text for the outgoing return file. Required and limited to 44 characters.

written_statement_obtained

boolean | null

Indicates whether the RDFI obtained a Written Statement of Unauthorised Debit from the receiver.
Mandatory and must be true for return codes as configured , (mandatory for the R07, R10, and R29; optional for other return codes).
Persisted to the audit nonmonetary record for compliance traceability.

Responses

500

Server Error

200Returns the ACH return queued for processing.

400Bad request

401Unauthorized

404Original transaction not found