ALalpacahq
Funding
Accounts

Retrieve Bank Relationships for an Account

Retrieves Bank Relationships for an account

get/v1/accounts/{account_id}/recipient_banks

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/accounts/{account_id}/recipient_banks
  • Auth
    HTTP basic

Query parameters

status'ACTIVE' | 'INACTIVE'
Example:ACTIVE
bank_namestring

Response

An array of Bank relationships attached to this Account.

An empty array will be returned if no Bank relationships have been attached to this account

account_idstring uuid
account_numberstring required
bank_codestring required

9-Digit ABA RTN (Routing Number) or BIC

bank_code_type'ABA' | 'BIC' required

ABA (Domestic) or BIC (International)

citystring

Only for international banks

countrystring

Only for international banks

created_atstring date-time required

Format: 2020-01-01T01:01:01Z

idstring uuid required
namestring required

Name of recipient bank

postal_codestring

Only for international banks

state_provincestring

Only for international banks

status'QUEUED' | 'SENT_TO_CLEARING' | 'APPROVED' | 'REJECTED' | 'CANCELED'

QUEUED, SENT_TO_CLEARING, APPROVED, REJECTED, CANCELED

street_addressstring

Only for international banks

updated_atstring date-time required

Format: 2020-01-01T01:01:01Z

Example response

[
  {
    "account_id": "56712986-9ff7-4d8f-8e52-077e099e533e",
    "account_number": "123456789abc",
    "bank_code": "123456789",
    "bank_code_type": "ABA",
    "city": "",
    "country": "",
    "created_at": "2022-02-11T21:35:19.268681613Z",
    "id": "8475c676-68e3-4cfc-a683-9ca2f47a6172",
    "name": "Bank XYZ",
    "postal_code": "",
    "state_province": "",
    "status": "QUEUED",
    "street_address": "",
    "updated_at": "2022-02-11T21:35:19.268681613Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.