Returns

Event

Description

created

A return has been created.

begin_processing

A return has begun processing. Originating returns only

finish_processing

A return has finished processing and been sent to the bank. Originating returns only

tentatively_reconciled

A return has been tentatively reconciled to a pending transaction. See the guide for more information.

Does not change the return's state.

completed

A return has been reconciled to a posted transaction.

failed

A return has failed due to an error.

These are the statuses a return may have:

Status

Description

pending

This is the initial state for a new return.

processing

This is a very short state where Modern Treasury is preparing the return to be sent to the bank. Originating returns only

sent

The return has been sent to the bank. It may remain in this state for up to a few days, depending on the type of return. Originating returns only

completed

The return has been reconciled to a posted bank transaction. At this point, we know the return was successful, and your account will have been debited or credited.

failed

This status is rare but may happen if there is an error at the bank.

{
  "event": "created",
  "data": {
    "id": "59981d98-7573-4e82-981e-acb1aaf4801e",
    "object": "return",
    "status": "pending",
    "returnable_id": "0383a613-1439-4ff8-992c-5e8691dfcc19",
    "returnable_type": "payment_order",
    "transaction_line_item_id": null,
    "transaction_id": null,
    "type": "ach",
    "amount": 20000,
    "currency": "USD",
    "code": "R03",
    "reason": "No Account/Unable to Locate Account",
    "role": "originating",
    "additional_information": null,
    "created_at": "2019-12-12T23:15:49Z",
    "updated_at": "2019-12-12T23:15:49Z"
  }
}