Create Payout Destination

curl --request POST \
  --url https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "country": "<string>",
  "type": "<string>",
  "currency": "<string>",
  "label": "<string>",
  "bank_name": "<string>",
  "bank_address": {},
  "correspondent_bank_name": "<string>",
  "correspondent_bank_address": {},
  "correspondent_bank_swift": "<string>",
  "account_holder": "<string>",
  "account_name": "<string>",
  "account_number": "<string>",
  "account_type": "<string>",
  "routing_number": "<string>",
  "iban": "<string>",
  "swift_code": "<string>",
  "pix_key": "<string>",
  "network": "<string>",
  "wallet_address": "<string>"
}
'

import requests

url = "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations"

payload = {
    "country": "<string>",
    "type": "<string>",
    "currency": "<string>",
    "label": "<string>",
    "bank_name": "<string>",
    "bank_address": {},
    "correspondent_bank_name": "<string>",
    "correspondent_bank_address": {},
    "correspondent_bank_swift": "<string>",
    "account_holder": "<string>",
    "account_name": "<string>",
    "account_number": "<string>",
    "account_type": "<string>",
    "routing_number": "<string>",
    "iban": "<string>",
    "swift_code": "<string>",
    "pix_key": "<string>",
    "network": "<string>",
    "wallet_address": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    country: '<string>',
    type: '<string>',
    currency: '<string>',
    label: '<string>',
    bank_name: '<string>',
    bank_address: {},
    correspondent_bank_name: '<string>',
    correspondent_bank_address: {},
    correspondent_bank_swift: '<string>',
    account_holder: '<string>',
    account_name: '<string>',
    account_number: '<string>',
    account_type: '<string>',
    routing_number: '<string>',
    iban: '<string>',
    swift_code: '<string>',
    pix_key: '<string>',
    network: '<string>',
    wallet_address: '<string>'
  })
};

fetch('https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations', 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}/beneficiaries/{beneficiary_id}/payout-destinations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'country' => '<string>',
    'type' => '<string>',
    'currency' => '<string>',
    'label' => '<string>',
    'bank_name' => '<string>',
    'bank_address' => [
        
    ],
    'correspondent_bank_name' => '<string>',
    'correspondent_bank_address' => [
        
    ],
    'correspondent_bank_swift' => '<string>',
    'account_holder' => '<string>',
    'account_name' => '<string>',
    'account_number' => '<string>',
    'account_type' => '<string>',
    'routing_number' => '<string>',
    'iban' => '<string>',
    'swift_code' => '<string>',
    'pix_key' => '<string>',
    'network' => '<string>',
    'wallet_address' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations"

	payload := strings.NewReader("{\n  \"country\": \"<string>\",\n  \"type\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"label\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"bank_address\": {},\n  \"correspondent_bank_name\": \"<string>\",\n  \"correspondent_bank_address\": {},\n  \"correspondent_bank_swift\": \"<string>\",\n  \"account_holder\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_type\": \"<string>\",\n  \"routing_number\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"swift_code\": \"<string>\",\n  \"pix_key\": \"<string>\",\n  \"network\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"<string>\",\n  \"type\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"label\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"bank_address\": {},\n  \"correspondent_bank_name\": \"<string>\",\n  \"correspondent_bank_address\": {},\n  \"correspondent_bank_swift\": \"<string>\",\n  \"account_holder\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_type\": \"<string>\",\n  \"routing_number\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"swift_code\": \"<string>\",\n  \"pix_key\": \"<string>\",\n  \"network\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country\": \"<string>\",\n  \"type\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"label\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"bank_address\": {},\n  \"correspondent_bank_name\": \"<string>\",\n  \"correspondent_bank_address\": {},\n  \"correspondent_bank_swift\": \"<string>\",\n  \"account_holder\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_type\": \"<string>\",\n  \"routing_number\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"swift_code\": \"<string>\",\n  \"pix_key\": \"<string>\",\n  \"network\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "beneficiary_id": "<string>",
  "country": "<string>",
  "payment_rails": [
    {}
  ],
  "type": "<string>",
  "label": "<string>",
  "currency": "<string>",
  "network": "<string>",
  "status": "<string>",
  "account_name": "<string>",
  "account_number_last4": "<string>",
  "account_type": "<string>",
  "routing_number": "<string>",
  "swift_code": "<string>",
  "iban_masked": "<string>",
  "clabe_last4": "<string>",
  "pix_key_last4": "<string>",
  "wallet_address_masked": "<string>",
  "bank_name": "<string>",
  "bank_address": {},
  "correspondent_bank_name": "<string>",
  "correspondent_bank_address": {},
  "correspondent_bank_swift": "<string>",
  "account_holder": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>"
}

POST

accounts

{account_id}

beneficiaries

{beneficiary_id}

payout-destinations

Create Payout Destination

curl --request POST \
  --url https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "country": "<string>",
  "type": "<string>",
  "currency": "<string>",
  "label": "<string>",
  "bank_name": "<string>",
  "bank_address": {},
  "correspondent_bank_name": "<string>",
  "correspondent_bank_address": {},
  "correspondent_bank_swift": "<string>",
  "account_holder": "<string>",
  "account_name": "<string>",
  "account_number": "<string>",
  "account_type": "<string>",
  "routing_number": "<string>",
  "iban": "<string>",
  "swift_code": "<string>",
  "pix_key": "<string>",
  "network": "<string>",
  "wallet_address": "<string>"
}
'

import requests

url = "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations"

payload = {
    "country": "<string>",
    "type": "<string>",
    "currency": "<string>",
    "label": "<string>",
    "bank_name": "<string>",
    "bank_address": {},
    "correspondent_bank_name": "<string>",
    "correspondent_bank_address": {},
    "correspondent_bank_swift": "<string>",
    "account_holder": "<string>",
    "account_name": "<string>",
    "account_number": "<string>",
    "account_type": "<string>",
    "routing_number": "<string>",
    "iban": "<string>",
    "swift_code": "<string>",
    "pix_key": "<string>",
    "network": "<string>",
    "wallet_address": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    country: '<string>',
    type: '<string>',
    currency: '<string>',
    label: '<string>',
    bank_name: '<string>',
    bank_address: {},
    correspondent_bank_name: '<string>',
    correspondent_bank_address: {},
    correspondent_bank_swift: '<string>',
    account_holder: '<string>',
    account_name: '<string>',
    account_number: '<string>',
    account_type: '<string>',
    routing_number: '<string>',
    iban: '<string>',
    swift_code: '<string>',
    pix_key: '<string>',
    network: '<string>',
    wallet_address: '<string>'
  })
};

fetch('https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations', 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}/beneficiaries/{beneficiary_id}/payout-destinations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'country' => '<string>',
    'type' => '<string>',
    'currency' => '<string>',
    'label' => '<string>',
    'bank_name' => '<string>',
    'bank_address' => [
        
    ],
    'correspondent_bank_name' => '<string>',
    'correspondent_bank_address' => [
        
    ],
    'correspondent_bank_swift' => '<string>',
    'account_holder' => '<string>',
    'account_name' => '<string>',
    'account_number' => '<string>',
    'account_type' => '<string>',
    'routing_number' => '<string>',
    'iban' => '<string>',
    'swift_code' => '<string>',
    'pix_key' => '<string>',
    'network' => '<string>',
    'wallet_address' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations"

	payload := strings.NewReader("{\n  \"country\": \"<string>\",\n  \"type\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"label\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"bank_address\": {},\n  \"correspondent_bank_name\": \"<string>\",\n  \"correspondent_bank_address\": {},\n  \"correspondent_bank_swift\": \"<string>\",\n  \"account_holder\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_type\": \"<string>\",\n  \"routing_number\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"swift_code\": \"<string>\",\n  \"pix_key\": \"<string>\",\n  \"network\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"<string>\",\n  \"type\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"label\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"bank_address\": {},\n  \"correspondent_bank_name\": \"<string>\",\n  \"correspondent_bank_address\": {},\n  \"correspondent_bank_swift\": \"<string>\",\n  \"account_holder\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_type\": \"<string>\",\n  \"routing_number\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"swift_code\": \"<string>\",\n  \"pix_key\": \"<string>\",\n  \"network\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id}/payout-destinations")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country\": \"<string>\",\n  \"type\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"label\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"bank_address\": {},\n  \"correspondent_bank_name\": \"<string>\",\n  \"correspondent_bank_address\": {},\n  \"correspondent_bank_swift\": \"<string>\",\n  \"account_holder\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_type\": \"<string>\",\n  \"routing_number\": \"<string>\",\n  \"iban\": \"<string>\",\n  \"swift_code\": \"<string>\",\n  \"pix_key\": \"<string>\",\n  \"network\": \"<string>\",\n  \"wallet_address\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "object": "<string>",
  "beneficiary_id": "<string>",
  "country": "<string>",
  "payment_rails": [
    {}
  ],
  "type": "<string>",
  "label": "<string>",
  "currency": "<string>",
  "network": "<string>",
  "status": "<string>",
  "account_name": "<string>",
  "account_number_last4": "<string>",
  "account_type": "<string>",
  "routing_number": "<string>",
  "swift_code": "<string>",
  "iban_masked": "<string>",
  "clabe_last4": "<string>",
  "pix_key_last4": "<string>",
  "wallet_address_masked": "<string>",
  "bank_name": "<string>",
  "bank_address": {},
  "correspondent_bank_name": "<string>",
  "correspondent_bank_address": {},
  "correspondent_bank_swift": "<string>",
  "account_holder": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>"
}

A payout destination is the bank account or blockchain wallet a beneficiary is paid into. Which fields are required depends on the destination type and, for bank accounts, on the identifiers you send. You do not choose payout rails: Hop derives them from the destination details and picks the rail for each payout from its own banking capabilities. Bank accounts are created active and can be paid immediately. Wallet destinations are created pending and must be approved by Hop before any payout can be released to them. Hop sends a payout_destination.updated webhook with the review outcome: status becomes active, or disabled if Hop rejects the wallet. Without a subscription, poll Get Payout Destination until status leaves pending. Requires an API key with write access on the payments scope.

Path Parameters

string

required

The account’s external ID (starts with acct_)

string

required

The beneficiary’s external ID (starts with bene_)

Request Body

Common fields

string

required

Payout country as an ISO 3166-1 alpha-2 code. Hop delivers to every country except those under Rejected countries; one of those is rejected with 422.

string

required

Destination type: bank_account or wallet

string

required

Currency this destination is paid in. The currency and the type must agree: a crypto currency requires type: "wallet", and a fiat currency requires type: "bank_account". A mismatched pair is rejected with 422 INVALID_FIELD_VALUE on currency.

string

Your own label for this destination

string

Receiving bank name (max 255 characters)

object

Receiving bank address: address_line, city and country required, region and postal_code optional

string

Correspondent bank name (max 255 characters)

object

Correspondent bank address, same shape as bank_address

string

Correspondent bank SWIFT/BIC code (max 11 characters)

string

Account holder, when it differs from account_name (max 255 characters)

Whitespace is stripped from account_number, routing_number, iban, swift_code, correspondent_bank_swift, pix_key and wallet_address before they are validated, so grouped digits such as 1234 5678 90 are accepted.

Bank account

Use these fields for any bank account except a PIX-only destination. Send account_number or iban, whichever the destination bank uses; account_type is required only alongside account_number.

string

required

Name on the receiving account (max 35 characters, the SWIFT field limit)

string

Bank account number (max 255 characters). Required when the destination has no IBAN. When country is MX this must be the 18-digit CLABE; there is no separate clabe request field.

string

Account type as free text (max 50 characters), for example checking or savings. Required alongside account_number. Hop does not restrict the value, so send what the receiving rail expects.

string

Bank routing number (max 100 characters)

string

IBAN (max 34 characters)

string

SWIFT/BIC code. Must be exactly 8 or 11 characters.

Bank account, PIX only

A Brazilian destination paid by PIX needs only the two fields below. No account number, account type, or routing details. If you also send an account_number or iban, the bank-account fields above apply as well.

string

required

Name on the receiving account (max 35 characters, the SWIFT field limit)

string

required

PIX key: CPF/CNPJ, email, phone, or random key (max 255 characters)

Wallet

string

required

Blockchain network. Mainnets: ethereum, solana, tron, plasma, bsc, polygon, xlm, avax, base. Testnets, non-production only: ethereum_sepolia, solana_devnet, tron_shasta.Must be a network the payout currency is released on; an unsupported pair returns 422 INVALID_FIELD_VALUE with details.field set to network. The pairs are listed on Create Wallet.

string

required

Destination wallet address on that network (max 255 characters)

Response

string

Payout destination identifier (starts with dest_)

string

Always returns "payout_destination"

string

Parent beneficiary external ID

string

Payout country

array

Payout rails Hop derived from the destination details: crypto for a wallet, pix when a PIX key was sent, spei for a Mexican account, swift for any other bank account. Always carries at least one element.

string

Destination type: bank_account or wallet

string

Destination label, or null

string

Currency

string

Blockchain network for a wallet, null for a bank account

string

Destination status: active, pending, or disabled. A new bank account is active; a new wallet is pending until Hop reviews it, and the outcome (active or disabled) raises payout_destination.updated.

string

Name on the receiving account, or null

string

Account number masked as four asterisks plus the last 4 characters, for example ****7890

string

Account type as supplied at creation. Free text, not a fixed set of values.

string

Bank routing number, or null

string

SWIFT/BIC code, or null

string

IBAN masked as the first 4 characters, four asterisks, and the last 4, for example GB29****6819

string

CLABE masked as **** plus the last 4 digits. For a Mexican destination this and account_number_last4 carry the same digits.

string

PIX key masked as **** plus the last 4 characters

string

Wallet address masked as the first 6 characters, four asterisks, and the last 4, for example 0x742d****0bEb

string

Receiving bank name, or null

object

Receiving bank address (address_line, city, region, postal_code, country), or null

string

Correspondent bank name, or null

object

Correspondent bank address, same shape as bank_address, or null

string

Correspondent bank SWIFT/BIC code, or null

string

Account holder, when it differs from account_name, or null

string

ISO 8601 timestamp when created

string

ISO 8601 timestamp when last updated

string

ID of the API key that created the destination (starts with ak_)

string

Actor that last updated the destination, or null

Errors

Status	`code`	When
`404`	`RESOURCE_NOT_FOUND`	No such beneficiary, it belongs to another account, or it has been deleted
`422`	`MISSING_REQUIRED_FIELD`	A field required by the destination type or details is absent; `details.field` names it: `account_name`, `account_number`, `account_type`, `pix_key`, `network`, or `wallet_address`
`422`	`INVALID_FIELD_VALUE`	The currency and the type disagree, for example a crypto currency with `type: "bank_account"`; `details.field` is `currency`
`422`	`INVALID_FIELD_VALUE`	A wallet `network` the currency is not released on; `details.field` is `network` and `details.currency` the currency
`422`	`INVALID_FIELD_FORMAT`	`country` is `MX` and `account_number` is not exactly 18 digits; `details.field` is `account_number`
`422`	`DUPLICATE_RESOURCE`	The details match an `active` or `pending` destination on the same beneficiary in the same currency; `details.existing_destination_id` names it. Destinations are matched on wallet address plus network, otherwise IBAN, otherwise PIX key, otherwise CLABE, otherwise account number plus routing number.
`422`	`VALIDATION_ERROR`	The body failed schema validation, for example a `swift_code` that is not 8 or 11 characters, an unknown `network`, a `country` Hop does not deliver to, or a value over its maximum length; `validation_errors` lists each field

Rejected countries

Hop does not deliver payouts to these countries. A country here, or a beneficiary country_code, is rejected with 422 VALIDATION_ERROR. Every other country is accepted.

Code	Country
`AF`	Afghanistan
`BY`	Belarus
`CU`	Cuba
`IQ`	Iraq
`IR`	Iran
`KP`	North Korea
`LR`	Liberia
`LY`	Libya
`MM`	Myanmar
`PK`	Pakistan
`RU`	Russia
`SD`	Sudan
`SY`	Syria
`VE`	Venezuela

Request Example

A US bank account:

{
  "country": "US",
  "type": "bank_account",
  "currency": "USD",
  "label": "Main Account",
  "account_name": "John Doe",
  "account_number": "1234567890",
  "account_type": "checking",
  "routing_number": "021000021",
  "bank_name": "Example Bank"
}

A crypto wallet:

{
  "country": "US",
  "type": "wallet",
  "currency": "USDC",
  "network": "ethereum",
  "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f00bEb",
  "label": "Treasury wallet"
}

Response Example

{
  "id": "dest_7hq3nd0xk52vplf9rtb1wcue",
  "object": "payout_destination",
  "beneficiary_id": "bene_9gt1ummgx127biovlurm9mq2",
  "country": "US",
  "payment_rails": ["swift"],
  "type": "bank_account",
  "label": "Main Account",
  "currency": "USD",
  "network": null,
  "status": "active",
  "account_name": "John Doe",
  "account_number_last4": "****7890",
  "account_type": "checking",
  "routing_number": "021000021",
  "swift_code": null,
  "iban_masked": null,
  "clabe_last4": null,
  "pix_key_last4": null,
  "wallet_address_masked": null,
  "bank_name": "Example Bank",
  "bank_address": null,
  "correspondent_bank_name": null,
  "correspondent_bank_address": null,
  "correspondent_bank_swift": null,
  "account_holder": null,
  "created": "2026-01-15T10:05:00Z",
  "updated": "2026-01-15T10:05:00Z",
  "created_by": "ak_0ub5w2xr8yl3qks6tcdn7m4v",
  "updated_by": null
}

Getting started

API basics

Endpoints

Webhooks

Create Payout Destination

Path Parameters

Request Body

Common fields

Bank account

Bank account, PIX only

Wallet

Response

Errors

Rejected countries

Request Example

Response Example

​Path Parameters

​Request Body

​Common fields

​Bank account

​Bank account, PIX only

​Wallet

​Response

​Errors

​Rejected countries

​Request Example

​Response Example

Path Parameters

Request Body

Common fields

Bank account

Bank account, PIX only

Wallet

Response

Errors

Rejected countries

Request Example

Response Example