v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
ACH Transaction Simulations

Simulate receiving ACH transaction

Use to simulate receiving ACH transaction in test environments. Creates an incoming ACH file with a single transaction, which gets automatically processed.

post/ach/transaction_simulations/receiving_transaction

Request body

account_numberstring required

Number of the receiving account

amountinteger required

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

dc_sign'credit' | 'debit' 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.

effective_datestring 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 request

{
  "account_number": "123638791329",
  "amount": 607,
  "dc_sign": "debit",
  "effective_date": "2022-03-18"
}

Response

Simulated receiving ACH transaction

AchSimulationResponse required