Skip to main content

Payments: Returns

Return Received ACH Transaction#

Returns a Received ACH transaction with a specified ACH Return Reason.

Returning a Received ACH transaction creates a Returned Received ACH transaction, posting the funds immediately in the opposite direction.

note

This API is not enabled by default for all customers. Please contact Unit if you need to enable this functionality.

Update Transaction

VerbPOST
Urlhttps://api.s.unit.sh/returns/:transactionId
Data TypereturnAch

Attributes#

NameTypeDescription
reasonstringThe ACH Return Reason for returning the transaction.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataReturnedReceivedAchTransactionTransaction resource.
Example Request:
{  "data": {    "type": "returnAch",    "attributes": {      "reason": "Unauthorized"    },    "relationships": {      "account": {        "data": {          "type": "depositAccount",          "id": "13052"        }      }    }  }}

ACH Return Reasons#

The following reasons can be used to initiate a return of a received ACH transaction:

TypeShort Description
UnauthorizedAccount is not authorized to receive the funds