Note:
- There is a limit of 1000 payment transfers for a single bulk payment API request.
- Plaid IAV integration is not available with bulk payments.
Bulk Payments Transfer Object
There are two objects to be passed-in within the request body; batch_details and transfers.
Batch Details
NAME | TYPE | DESCRIPTION |
---|---|---|
account_number required |
string | SVB bank account number originating the ACH transfer.
If testing on sandbox use the account number '1111111111'. |
company_entry_description | string | 10 character transaction description field specified by the originator, applies to the batch header. |
counterparty_id | int | ID of the counterparty resource to use in place of receiver_ fields. |
direction required |
enum(“credit”, “debit”) | Direction of the transfer. |
effective_date | date | Date when the transfer should take place. Defaults to tomorrow’s date. |
sec_code required |
enum(“ccd”, “ppd”, “web”) | SEC code to be used for the ACH transfer. |
service | enum(“standard”, “same-day”) | Service level. Defaults to standard service. |
Transfers
NAME | TYPE | DESCRIPTION |
---|---|---|
amount required |
int | Amount of money to transfer, specified in cents.
Example: To pass in $10.55, use "1055" as the amount. No decimals should be used to represent amount. |
currency | enum("USD") | If not provided, defaults to "USD". |
memo conditionally required |
string |
Conditionally required 15 digit alphanumeric string that can be used to pass data to the recipient bank. Examples: an invoice number or transaction reference number. For person to person WEB credit transactions, this field is required and should contain the name of the consumer (originator). |
receiver_account_number conditionally required |
string | Bank account number that is receiving the ACH transfer.
* required if no counterparty_id is supplied. |
receiver_account_type conditionally required |
enum(“checking”, “savings”) | Type of bank account that is receiving the ACH transfer.
*required if no counterparty_id is supplied. |
receiver_name conditionally required |
string | Name of the holder of the receiving account.
*required if no counterparty_id is supplied. |
receiver_routing_number conditionally required |
string | ABA routing number associated with the receiver_account_number .
*required if no counterparty_id is supplied. |
idempotency_key | string | Customer generated unique key for each transfer. |