POST
/
ach
/
transaction_simulations
/
receiving_transaction
Simulate receiving ACH transaction
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/ach/transaction_simulations/receiving_transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_number": "123638791329",
  "amount": 607,
  "dc_sign": "debit",
  "effective_date": "2022-03-18"
}'
{}

Authorizations

Authorization
string
header
required

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

Body

application/json

Sent ACH request

Simulate receiving an ACH transaction

account_number
string
required

Number of the receiving account

Example:

"123638791329"

amount
integer
required

Amount to transfer in cents (e.g. 100 = $1). Generates a prenote if set to 0.

Required range: 0 <= x <= 9999999999
Example:

607

dc_sign
enum<string>
required

The type of transaction (debit or credit) in relation to the receiving account. A credit is a transfer in and a debit is a transfer pulling money out of the receiving account.

Available options:
credit,
debit
Example:

"debit"

effective_date
string<date>
required

Effective date of the transaction. Transactions with the current date or date in the past are posted immediately. Future-dated transactions are scheduled to be posted on the chosen date.

Example:

"2022-03-18"

Response

Simulated receiving ACH transaction

The response is of type object.