POST
/
user_banks
curl --request POST \
  --url https://api.useswift.dev/user_banks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_number": "12345678",
  "account_holder_type": "individual",
  "bank_account_type": "checking",
  "routing_number": "12345678",
  "user_id": "user_vjb43lkAdf934jb13Df93"
}'
{
  "account_number": "12345678",
  "account_holder_type": "individual",
  "bank_account_type": "checking",
  "created_at": "2024-01-31T23:59:59Z",
  "id": "user_bank_vjb43lkAdf934jb13Df93",
  "is_rtp_enabled": true,
  "is_rtp_rfp_enabled": true,
  "routing_number": "12345678",
  "status": "active",
  "user_id": "user_vjb43lkAdf934jb13Df93",
  "verification_status": "verified"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Parameters for creating a User Bank.

​
account_number
string
required

The bank account number.

​
account_holder_type
enum<string>
required

The type of the account holder.

Available options:
individual,
business
​
bank_account_type
enum<string>
required

The type of the bank account.

Available options:
checking,
savings
​
routing_number
string
required

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the account.

Required string length: 9
​
user_id
string
required

The User ID for which this bank account belongs and is linked to.

Response

200
application/json
User Bank

User Banks represent bank accounts linked to a User.

​
account_number
string
required

The bank account number.

​
account_holder_type
enum<string>
required

The type of the account holder.

Available options:
individual,
business
​
bank_account_type
enum<string>
required

The type of the bank account.

Available options:
checking,
savings
​
created_at
string
required

The ISO 8601 time at which the User Bank was created.

​
id
string
required

The User Bank's unique identifier.

​
is_rtp_enabled
boolean
required

Indicates if the User Bank is eligible to receive transfers via the Real-Time Payments network.

​
is_rtp_rfp_enabled
boolean
required

Indicates if the User Bank is eligible to receive Requests for Payment via the Real-Time Payments network.

​
routing_number
string
required

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the account.

Required string length: 9
​
status
enum<string>
required

The current status of the User Bank.

Available options:
active,
archived
​
user_id
string
required

The User ID for which this bank account belongs and is linked to.

​
verification_status
enum<string>
required

The current verification status of the User Bank.

Available options:
unverified,
pending,
verified