Get Deposit Instructions
What a payer needs to send money into one bank account: its own account number and holder, with the routing number, SWIFT code, name and address of the bank that holds it. Every bank account answers with its own details, so an account holding several bank accounts gets the right number for each.
Only a bank account money can be paid into has instructions: a deposit bank account that is active at the bank. A reserve, a bank account still pending at the bank, or an inactive one answers 409 deposit_instructions_not_available.
v2's Deposit Instructions answers one set of instructions for a whole account; this endpoint answers for each bank account.
Authorization:
Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.
Headers:
Authorization: APIKey {SIGNED_JWT}
How to build and sign the JWT: Authentication.
Endpoint
/v3/bank-accounts/{bank_account_id}/deposit-instructions
Path parameters
| Parameter | Type | Description |
|---|---|---|
bank_account_id | string (bnk_…) | Required. The bank account. |
Both kinds of key may call it. An account-scoped key reads only its own account's bank accounts; another account's reads as 404. A workspace-scoped key reads any bank account of the workspace.
Response Sample
{
"bank_account_id": "bnk_01k8x4m2qv7r3t5w9y1a3c5e7g",
"name": "Operating",
"currency": "USD",
"account_number": "555000114019",
"routing_number": "123456789",
"account_type": "checking",
"swift": "EXMPUS33",
"bank_name": "Example Bank",
"bank_address": "100 Example Street, New York, NY 10001, US",
"beneficiary_name": "Ava Kim"
}
Response Schema
| Field | Type | Description |
|---|---|---|
bank_account_id | string (bnk_…) | The bank account. |
name | string | Its name. A bank account that was never named shows as its currency plus account, for example USD account. |
currency | string | The currency it takes: USD, MXN, ARS, COP, BRL or NGN. |
account_number | string | The number a payer sends money to: this bank account's own, in full. |
routing_number | string | The ABA routing number a domestic wire or ACH is sent to: the bank account's own when the bank gave it one, otherwise the bank's. Absent when there is none. |
account_type | string | The type the bank recorded, for example checking. Absent when it recorded none. |
swift | string | The SWIFT/BIC code for an international wire. Absent when the bank has none. |
bank_name | string | The bank that holds the bank account. |
bank_address | string | The bank's address. Absent when it is not known. |
beneficiary_name | string | The holder a payer names as beneficiary: the name the bank recorded for the bank account, or else the account holder's name. |
Errors
| Status | message | When |
|---|---|---|
400 | failed to parse request | bank_account_id is not a bnk_… id. |
401 | unauthorized | Missing or invalid signature. |
404 | bank_account_not_found | No such bank account, it belongs to another account, or the account that held it was deleted. |
409 | deposit_instructions_not_available | Nothing can be paid into this bank account: it is a reserve, it is still pending or inactive, it has no account number, or its bank's details are not available. |
Support and Resources
If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.
Stay Updated
Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:
- Instagram: BlockWyre Instagram
- Twitter: BlockWyre Twitter
- Facebook: BlockWyre Facebook
- LinkedIn: BlockWyre LinkedIn
We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!