Create a new Return

post

https://sandbox.newline53.com/api/v1/returns

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).

Body Params

external_uid

string

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_uid

string

required

The transaction to be returned.

requesting_customer_uid

string

required

The UID of the customer requesting a return.

requestor_type

string

enum

required

Type of the customer requesting a return.

Allowed:

return_reason

string

required

length ≤ 140

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

ach

object

wire

object

Headers

x-trace-id

string

required

A unique identifier provided for each request. Duplicate values submitted in requests within 7 days of each other will cause the request to be rejected.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

201A single registered Return is returned.

400Creation Error

403Denied access to Returns

422Creation Error