v1

latestOpenAPI 3.1.02026-07-26457177.8 KB

Payment Instruments

Get Payment Instrument by an ID

📘

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 👉.

🚧

Payment Instruments are required for Real-Time (FedNow, RTP) and T+0 Same Day ACH payment flows. Please reach out to your Astra Integration Specialist for more information.

🚧

There may be up to a 5 minute delay in calculating the true available balance of a payment instrument.

Retrieves a specific Payment Instrument for a Client.

get/v1/payment_instruments/{id}

Path parameters

idstring required

The Payment Instrument ID

Response

Successful response

idstring

The unique ID of the Payment Instrument

namestring

The Payment Instrument name

account_numberstring

The account number (Note - Astra-internal operational account numbers will be redacted)

maskstring

The account mask

routing_numberstring

The routing number (Note - Astra-internal operational routing numbers will be redacted)

created_atstring date-time

The date and time when the Payment Instrument was created (UTC)

program_role'fee' | 'program' | 'settlement' | 'suspense' | 'reserve'

The program role

The status of the Payment Instrument

type'depository'

The account type

sub_type'checking' | 'savings'

The account subtype

updated_atstring date-time

The date and time the Payment Instrument was last updated (UTC)