Simulate receiving ACH return

Use to simulate receiving ACH return in test environments. Creates an incoming ACH file with a single return entry based on a previously created outgoing transaction. The file gets automatically processed.

POST /ach/transaction_simulations/receiving_return

Simulate receiving ACH return

cURL

curl --request POST \
  --url https://api.synctera.com/v2/ach/transaction_simulations/receiving_return \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ach_id": "23a37f14-16eb-461d-9331-b78182adbad4"
}
'

201

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Incoming ACH return simulation

Simulate receiving an ACH return

ach_id · string<uuid> · required

ID of an outgoing ACH transfer to be returned.

Example:

"23a37f14-16eb-461d-9331-b78182adbad4"

Response

201

application/json

Simulated receiving ACH return

The response is of type object.