Sign in

v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
Transfers

Get a Specific Batch Transfer

📘

You can place your application's client_id into the username field, and your client_secret into the password form field of the Authentication section of this documentation 👉.

Retrieve Batch Transfer data for a specific Batch Transfer.

get/v1/batch_transfers/{id}

Path parameters

idstring required

The Batch Transfer ID

Response

Successful response

idstring

The unique ID of the Batch Transfer

addendastring

The addenda of the ACH debit/credit associated with this batch transfer

amountinteger

The amount in cents

createdstring date-time

The date and time the Batch Transfer was created

failure_reasonstring

The reason that the Batch Transfer was not successful (null if no failure)

item_countnumber

The number of Transfers associated with the Batch

item_type'ach_transfer' | 'debit_chargeback' | 'interchange_network_fees'

The type of Batch Transfer

preliminary_amountinteger

The preliminary amount in cents

processing_scheduled_atstring date-time

The date and time when the Batch Transfer is scheduled to run

source_idstring

The source account unique identifier

source_inststring

The source account institution

source_maskstring

The source account number mask

source_namestring

The source account name

source_typestring

The source account type

status'open' | 'processing' | 'failed' | 'canceled' | 'completed'

The status of the Batch Transfer

transfer_typestring

The type of transfer

updatedstring date-time

The date and time when the Batch Transfer was last updated

user_emailstring

The email address of the User associated with the Batch Transfer

user_idstring

The User ID associated with the Batch Transfer