latestOpenAPI 3.0.22026-08-21530310.0 KB

54f4fe726d8f

Returns

Create a new Return

Initiates a Return of an ACH or wire payment. A full ACH addenda is not available for ACH returns because an addenda record is used for the return itself; the addenda_info field contains the remaining available space. For wire returns, the wire_instruction field is limited to 70 characters because Newline prefixes the instructions with the original wire transaction identifier (e.g., IMAD).

post/returns

Request body

external_uidstring

Client supplied unique identifier. It must be unique within the customer. If the same value is given, no new resource will be created.

original_transaction_uidstring required

The transaction to be returned.

requesting_customer_uidSchema required— unresolved $ref
requestor_typeSchema required— unresolved $ref
return_reasonstring required

Freeform text (up to 140 characters) documenting the reason for return. For wire returns, this value will be sent to the other bank.