Create Return

post

https://app.moderntreasury.com/api/returns

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

returnable_id

string

required

The ID of the object being returned.

returnable_type

string

required

The type of object being returned. Currently, this may only be incoming_payment_detail.

code

string

For ACH returns, this is the required ACH return code. Refer to the guide on originating ACH returns for a full list of acceptable codes.

reason

string

An optional description of the reason for the return. This is for internal usage and will not be transmitted to the bank.

date_of_death

date

If the return code is R14 or R15, a date of death must be provided.

additional_information

string

If provided, this string will populate the addenda information field of the ACH addenda record. Only the first 44 characters of this string will be used. Any additional characters will be truncated.

ledger_transaction

object

Specifies a ledger transaction object that will be created with the return. If the ledger transaction cannot be created, then the return creation will fail. The resulting ledger transaction will mirror the status of the return. See Linking to other Modern Treasury objects.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here!