Return ACH RDFI transaction

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.

Request

Security:

Bearer

path Parameters

version

required

string

Request Body schema: application/json

txn_guid	string or null <uuid> Original transaction reference. Either "txn_guid" or "bank_eft_guid is required.
bank_eft_guid	string or null <uuid> The original EFT transaction reference. Either "bank_eft_guid" or "txn_guid" is required.
return_code required	string [ 1 .. 8 ] characters ACH return reason code (Allowed values: R05, R06, R07, R10, R13, R14, R15, R16, R17, R20, R29, R31.)
addenda_description required	string [ 1 .. 44 ] characters Free-form addenda information text for the outgoing return file. Required and limited to 44 characters.
written_statement_obtained	boolean or 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

200

Returns the ACH return queued for processing.

400

Bad request

401

Unauthorized

404

Original transaction not found

500

Server Error

post/api/{version}/transfers/ach/return

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
"bank_eft_guid": "b91916c2-ae47-47fc-87e2-5a0a340e4c0b",
"return_code": "string",
"addenda_description": "string",
"written_statement_obtained": true
}

Response samples

application/json

{"return_bank_eft_guid": "a12cf629-60a8-4b42-b65c-80cf03e22f8b",
"reverse_txn_guid": "1c5ffe75-1896-4946-ad70-748a1803a4ef",
"message": "string",
"txn_guid": "0017d7fb-f072-440d-86fd-a7ae6238e591",
"bank_eft_guid": "b91916c2-ae47-47fc-87e2-5a0a340e4c0b",
"return_code": "string",
"addenda_description": "string",
"written_statement_obtained": true
}