Deposit Instructions
This endpoint returns the deposit instructions for a specific account. Use these instructions to receive payments via ACH or wire transfer.
Prerequisites
- The account must have a bank account opened (see Open Bank Account, or v3's Open a Bank Account). Without one, this endpoint answers
204 No Content. - It answers with one
accountNumberfor the whole account. When the account holds several bank accounts, that number is not necessarily the one just opened through v3, nor the default, nor one in a given currency. For one bank account's own instructions, use v3's Get Deposit Instructions.
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
/api/v2/banking/deposit-instructions/{accountId}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
accountId | string (uuid) | Required. The account ID to get deposit instructions for. |
Response Sample
{
"reference": "BW0000 ABC123",
"routingNumber": "123456789",
"accountNumber": "1234567890",
"swift": "SWIFT123",
"iban": "US001234561234567890123456",
"accountType": "checking",
"status": "active",
"bankName": "Blockwyre Virtual Bank",
"bankAddress": "1234 BlockWyre St, BlockWyre 00000, US",
"beneficiaryName": "John Wick",
"beneficiaryAddress": "123 Main St, New York, NY 10001"
}
Response Schema
| Field | Type | Description |
|---|---|---|
reference | string | The reference number for wire transfers. Include this in the memo/reference field when sending funds (optional). |
routingNumber | string | The routing number for ACH transfers. |
accountNumber | string | The account number. |
swift | string | The SWIFT code for wire transfers. |
iban | string | The IBAN (International Bank Account Number). |
accountType | string | The type of bank account. Values: checking, savings. |
status | string | The status of the bank account. Values: pending, active, closed. |
bankName | string | The name of the bank (optional). |
bankAddress | string | The address of the bank (optional). |
beneficiaryName | string | The name of the account beneficiary (optional). |
beneficiaryAddress | string | The address of the account beneficiary (optional). |
Errors
| Status | Message | Meaning |
|---|---|---|
409 | banking_operation_unsupported | The workspace's bank does not give deposit instructions. |
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!