Get Wire Instructions

Overview

The Get Wire Instructions API allows you to retrieve the banking details and wire transfer instructions for a specific business. These instructions are required for sending wire transfers to the business account.

Resource Access

• HTTP Method: GET
• Endpoint: /v1/businesses/{business_id}/wire_instructions
• Authentication: Bearer token required

Path Parameters

Parameter	Type	Required	Description
business_id	string (UUID)	Yes	Unique identifier for the business

Request Headers

Header	Value	Required	Description
Accept	application/json	Yes	Content type for the response
Authorization	Bearer {access_token}	Yes	Bearer token for authentication

Response

Success Response (200 OK)

{
  "business_id": "urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc",
  "wire_instructions": {
    "bank_name": "First National Bank",
    "account_name": "Ahrvo Network Financial Inc.",
    "account_number": "123456789012",
    "routing_number": "021000021",
    "swift_code": "FNBAUS33",
    "bank_address": {
      "street": "123 Main Street",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    },
    "intermediary_bank": null,
    "reference": "Business ID: urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc",
    "currency": "USD"
  },
  "created_at": "2022-01-01T00:00:00.000Z",
  "updated_at": "2022-01-01T00:00:00.000Z"
}

Response Fields

Field	Type	Description
business_id	string (UUID)	Business identifier
wire_instructions	object	Wire transfer instructions
created_at	string (date-time)	When the wire instructions were created
updated_at	string (date-time)	When the wire instructions were last updated

Wire Instructions Fields

Field	Type	Description
bank_name	string	Name of the bank
account_name	string	Name on the account
account_number	string	Bank account number
routing_number	string	ABA routing number (US domestic)
swift_code	string	SWIFT/BIC code (international)
bank_address	object	Bank address information
intermediary_bank	object/null	Intermediary bank details (if applicable)
reference	string	Reference/memo to include with wire transfer
currency	string	Supported currency (USD, EUR, GBP)

Bank Address Fields

Field	Type	Description
street	string	Street address
city	string	City
state	string	State or province
postal_code	string	Postal code
country	string	Country code (ISO 3166-1 alpha-2)

Error Responses

• 401 Unauthorized: Invalid or missing authentication token
• 404 Not Found: Business not found or wire instructions not available

Code Examples

cURL

curl -X GET \
  'https://api.example.com/v1/businesses/urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc/wire_instructions' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Python

import requests

url = "https://api.example.com/v1/businesses/urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc/wire_instructions"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://api.example.com/v1/businesses/urn:uuid:9b397b0d-69bc-b09f-9d82-0e02637042fc/wire_instructions';
const headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
};

axios.get(url, { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error.response.data);
  });

Usage Notes

• Wire instructions are specific to each business and may change over time
• Always use the most recent wire instructions for transfers
• Include the reference field in your wire transfer to ensure proper crediting
• For international transfers, use the SWIFT code instead of routing number
• Contact support if wire instructions appear incorrect or outdated

Interactive API Explorer