Sign in

v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
Transfers

Get a Specific Transfer for a User

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint retrieves a specific Transfer for a User based on the Transfer ID.

get/v1/transfers/{id}

Path parameters

idstring required

The Transfer ID

Response

Successful response

idstring

The unique ID of the transfer

routine_type'one-time' | 'recurring'

The type of routine associated with the transfer

routine_namestring

The name of the routine associated with the transfer

routine_idstring

The unique ID of the routine associated with the transfer

client_correlation_idstring

An optional correlation id that will be added to ACH or Debit Addenda. This will also be included in the Transfer response.

source_idstring

The ID of the Source Account

destination_idstring

The ID of the Destination Account

destination_user_idstring

The User ID associated with the Destination Account (if peer-to-peer)

amountnumber float

The amount of the transfer (when explicitly defined like one-time or recurring)

payment_type'ach' | 'debit' | 'ledger'

The type of payment

initiatedstring date-time

The date and time the transfer was initiated

net_credit_batch_idstring

The Net Credit Batch Transfer ID associated with this transfer

net_debit_batch_idstring

The Net Debit Batch Transfer ID associated with this transfer

updatedstring date-time

The date and time the transfer was updated

estimated_clearing_datestring date-time

The estimated date and time the transfer will clear

astra_settlement_reasonstring

The reason that an estimated settlement date may have been changed

failure_reasonstring

The reason that astra transfer was not successful

status'pending' | 'processed' | 'cancelled' | 'failed'

The status of the Transfer