Get Deposit Instruction

curl --request GET \
  --url https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "<string>",
  "account_id": "<string>",
  "currency": "<string>",
  "payment_attribution": "<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>"
}

GET

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 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/v1/accounts/{account_id}/deposit-instructions/{currency}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "<string>",
  "account_id": "<string>",
  "currency": "<string>",
  "payment_attribution": "<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>"
}

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

string

required

The account’s external ID (starts with acc_)

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

string

Deposit instruction identifier

string

Always returns "deposit_instruction"

string

Parent account ID

string

ISO 4217 currency code

string

Payment attribution method: virtual_account or memo_reference

string

Status: active or revoked

string

Name of the beneficiary for the deposit

string

Address of the beneficiary

string

Name of the receiving bank

string

Address of the receiving bank

string

Name on the bank account

string

Bank account number

string

International Bank Account Number

string

SWIFT/BIC code

string

Bank routing number

string

Sort code (UK banking)

string

Memo or reference to include with transfers (for memo_reference strategy)

array

Supported payment rails (e.g., ach, fedwire, swift, sepa, spei)

string

ISO 8601 timestamp when created

string

ISO 8601 timestamp when last updated

When Unavailable

string

Returns "deposit_instruction"

string

The requested currency code

string

Returns "unavailable"

string

Human-readable explanation

Response Examples

Available

{
  "id": "hba_1234567890abcdef",
  "object": "deposit_instruction",
  "account_id": "acc_1234567890abcdef",
  "currency": "USD",
  "payment_attribution": "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."
}

List Deposit Instructions Create Wallet

Getting Started

Guides

Webhooks

API Reference

Endpoints

Get Deposit Instruction

Path Parameters

Response

When Available

When Unavailable

Response Examples

Available

Unavailable

​Path Parameters

​Response

​When Available

​When Unavailable

​Response Examples

​Available

​Unavailable

Path Parameters

Response

When Available

When Unavailable

Response Examples

Available

Unavailable