Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
deposit-instructions
/
{currency}
Get Deposit Instruction
curl --request GET \
  --url https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "account_id": "<string>",
  "currency": "<string>",
  "recon_strategy": "<string>",
  "status": "<string>",
  "beneficiary_name": "<string>",
  "beneficiary_address": "<string>",
  "bank_name": "<string>",
  "bank_address": "<string>",
  "account_name": "<string>",
  "account_number": "<string>",
  "iban": "<string>",
  "swift_bic": "<string>",
  "routing_number": "<string>",
  "sort_code": "<string>",
  "memo": "<string>",
  "supported_rails": [
    {}
  ],
  "created": "<string>",
  "updated": "<string>",
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.hopnow.io/llms.txt

Use this file to discover all available pages before exploring further.

Deposit instructions are for fiat currencies only (e.g., USD, EUR, GBP, JPY, HKD). To receive crypto deposits, use the Wallets API instead. Fiat currencies must be enabled for your account — if a currency returns "status": "unavailable", contact support to enable it. See the Deposit Flows guide for a complete overview.

​
Path Parameters

​
account_id
string
required
The account’s external ID (starts with acc_)
​
currency
string
required
ISO 4217 currency code (e.g., USD, EUR, GBP)

​
Response

Returns a deposit instruction object when available, or an unavailability response when no instructions exist for the requested currency.

​
When Available

​
id
string
Deposit instruction identifier
​
object
string
Always returns "deposit_instruction"
​
account_id
string
Parent account ID
​
currency
string
ISO 4217 currency code
​
recon_strategy
string
Reconciliation strategy: virtual_account or memo_reference
​
status
string
Status: active or revoked
​
beneficiary_name
string
Name of the beneficiary for the deposit
​
beneficiary_address
string
Address of the beneficiary
​
bank_name
string
Name of the receiving bank
​
bank_address
string
Address of the receiving bank
​
account_name
string
Name on the bank account
​
account_number
string
Bank account number
​
iban
string
International Bank Account Number
​
swift_bic
string
SWIFT/BIC code
​
routing_number
string
Bank routing number
​
sort_code
string
Sort code (UK banking)
​
memo
string
Memo or reference to include with transfers (for memo_reference strategy)
​
supported_rails
array
Supported payment rails (e.g., ach, fedwire, swift, sepa, spei)
​
created
string
ISO 8601 timestamp when created
​
updated
string
ISO 8601 timestamp when last updated

​
When Unavailable

​
object
string
Returns "deposit_instruction"
​
currency
string
The requested currency code
​
status
string
Returns "unavailable"
​
message
string
Human-readable explanation

​
Response Examples

​
Available

{
  "id": "hba_1234567890abcdef",
  "object": "deposit_instruction",
  "account_id": "acc_1234567890abcdef",
  "currency": "USD",
  "recon_strategy": "virtual_account",
  "status": "active",
  "beneficiary_name": "Hop Innovations Inc",
  "beneficiary_address": "123 Main St, New York, NY 10001",
  "bank_name": "Partner Bank",
  "bank_address": "456 Wall St, New York, NY 10005",
  "account_name": "Hop Innovations Inc",
  "account_number": "1234567890",
  "iban": null,
  "swift_bic": "CHASUS33",
  "routing_number": "021000021",
  "sort_code": null,
  "memo": null,
  "supported_rails": ["ach", "fedwire"],
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-01T00:00:00Z"
}

​
Unavailable

{
  "object": "deposit_instruction",
  "currency": "JPY",
  "status": "unavailable",
  "message": "Deposit instructions are not yet available for this currency. Please contact support."
}