API Reference

Create bank link

post
https://api.astrada.co/bank-links

Creates a new bank link to initiate a bank enrollment. The response includes a hostedLink URL where the user can connect their bank account via Plaid.

The hosted link expires after 4 hours. If the link expires before the user completes enrollment, retrieve the bank link via GET /bank-links/{bankLinkId} to get a refreshed URL.

Creating a bank link with an ID that already exists for the account will return a 409 Conflict error, unless the existing link has expired.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Bank link creation request

string
required
length between 1 and 256
^[a-zA-Z0-9_-]+$

A client-provided identifier for the bank link. Must be alphanumeric with hyphens and underscores only.

uuid
required

The subaccount identifier to associate with this bank link.

filters
object

Optional per-link narrowing of the account's bank-linking policy. Values may
only NARROW what the policy allows — the current system default is
accountTypes: [credit] (credit-card accounts only). Requests widening beyond
the policy are rejected with 400. Account-type enforcement is applied by the
provider at link-token creation and also filters the institution-select list.

string
^\d{6}$

First 6 digits captured client-side before an institution
pivot (e.g. an American Express BIN typed into the card form
before the SDK pivots to bank linking). Persisted with the
link and attached to the completion-time bank-derived card
mint when exactly one card is minted — it becomes that
card's first6digits.

Headers
Responses

Updated 16 days ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 16 days ago

Did this page help you?