API Reference

Create ACH Transfer

post
https://api.sb.spidrsrv.com/v1/transaction/createAchTransfer

Use the /createAchTransfer endpoint to originate an ACH transaction to move funds between a customer account and external bank account linked via Create ACH Account. The originator of this transaction is your customer/bank and the recipient is the holder of the external account.

If the associated ACH account was created via a linkedInstitutionAccountId, balance checks are automatically performed to ensure sufficient funds for ACH pulls (contingent on your product's configuration).

The ACH transfer created via this endpoint can either be a push (credit) or pull (debit) to the recipient account. To view a list of ACH transfers originated by an account, use the List ACH Requests endpoint. To cancel an ACH transfer, use the Cancel ACH Transfer endpoint. For more information on ACH accounts and transactions, please see ACH Accounts and Transactions.

Body Params

POST /v1/transaction/createAchTransfer Request body

string

The session key for the user. Created via Create ZTM Session and used for ZTM checks if your program is configured for ZTM.

boolean

Indicates whether to bypass the ZTM checks if your program is configured for ZTM.

string
required

Pass in the Spidr account ID

string
required

Pass in the ACH account's unique ID created via the 'Create ACH Account' endpoint.

double
required
≤ 10000000

The amount of the ACH transaction.

string
required
length ≤ 30

The description of the ACH transaction.

string | null

The remittance information for the ACH transaction.

string
enum
required

Specifies whether the recipient account is to be credited or debited. C = Credit (ACH Push), D = Debit (ACH Pull)

Allowed:
boolean
Defaults to false

Indicates if the transaction is a same-day ACH transaction. Requires bank approval and Spidr configuration.

int64

The number of hold days to apply to this transaction, which overrides the hold days in your program settings. This value applies only to outgoing ACH debits (debitCreditIndicator: D). This parameter requires bank approval and Spidr configuration.

boolean

Indicates if the balance of the ACH account should be checked before creating the transaction.

double
≤ 10000000

The minimum balance of the ACH account after the transaction is debited. i.e. how much money should be left in the account after the transaction is debited.

Responses

Updated 7 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago