Create a beneficiary

curl --request POST \
  --url https://api.globalstack.io/v1/beneficiaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "label": "<string>",
  "currency": "<string>",
  "network": "<string>",
  "metadata": {},
  "merchant_reference": "<string>",
  "customer_id": "<string>",
  "country_code": "<string>",
  "provider_id": "<string>",
  "account_number": "<string>",
  "account_name": "<string>",
  "address": "<string>"
}
'

import requests

url = "https://api.globalstack.io/v1/beneficiaries"

payload = {
    "name": "<string>",
    "label": "<string>",
    "currency": "<string>",
    "network": "<string>",
    "metadata": {},
    "merchant_reference": "<string>",
    "customer_id": "<string>",
    "country_code": "<string>",
    "provider_id": "<string>",
    "account_number": "<string>",
    "account_name": "<string>",
    "address": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    label: '<string>',
    currency: '<string>',
    network: '<string>',
    metadata: {},
    merchant_reference: '<string>',
    customer_id: '<string>',
    country_code: '<string>',
    provider_id: '<string>',
    account_number: '<string>',
    account_name: '<string>',
    address: '<string>'
  })
};

fetch('https://api.globalstack.io/v1/beneficiaries', 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.globalstack.io/v1/beneficiaries",
  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([
    'name' => '<string>',
    'label' => '<string>',
    'currency' => '<string>',
    'network' => '<string>',
    'metadata' => [
        
    ],
    'merchant_reference' => '<string>',
    'customer_id' => '<string>',
    'country_code' => '<string>',
    'provider_id' => '<string>',
    'account_number' => '<string>',
    'account_name' => '<string>',
    'address' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.globalstack.io/v1/beneficiaries"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"network\": \"<string>\",\n  \"metadata\": {},\n  \"merchant_reference\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"provider_id\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"address\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.globalstack.io/v1/beneficiaries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"network\": \"<string>\",\n  \"metadata\": {},\n  \"merchant_reference\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"provider_id\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"address\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.globalstack.io/v1/beneficiaries")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"network\": \"<string>\",\n  \"metadata\": {},\n  \"merchant_reference\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"provider_id\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"address\": \"<string>\"\n}"

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

{
  "status": true,
  "message": "Beneficiary created successfully",
  "code": "ok",
  "data": {
    "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
    "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
    "name": "Alice Bank Beneficiary",
    "type": "fiat",
    "currency": "NGN",
    "details": {
      "country_code": "NG",
      "network": "bank",
      "account_number": "0039415616",
      "provider": {
        "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
        "name": "Access Bank",
        "code": "000014"
      },
      "account_name": "ALICE JOHNSON"
    },
    "metadata": {},
    "status": "pending",
    "created_at": "2026-04-16T16:14:08.000Z",
    "updated_at": "2026-04-16T16:14:08.000Z",
    "label": "Alice's salary account",
    "merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Beneficiaries

Create a beneficiary

Create a beneficiary for fiat payouts (offramp) or crypto outbound transfers.

Pass type, currency, and corridor fields at the top level (country_code, network, account_number,provider_id, routing_number, address, etc.). On read, we nest account information under details and expand provider_id to provider.

Body — shared fields

type — required. One of fiat, crypto.
name — required. Max 255 chars.
label — required. Max 128 chars.
currency — required. ISO/crypto currency code (2–8 uppercase alphanumerics).
metadata — optional. Free-form Record<string, string>.
merchant_reference — optional. Max 128 chars. Auto-generated as ref_<ULID> when omitted. Per-integration unique.
customer_id — optional. GlobalStack customer external id (cust_<ULID>). When omitted, the integration’s default customer is used; in that case data.customer_id in the response will carry the default customer’s external id, which is intentionally not addressable via GET /v1/customers/:customer_id.

Body — fiat fields (`type = "fiat"`)

country_code — required. ISO-3166-1 alpha-2 (e.g. NG, KE).
provider_id — required. GlobalStack provider external id (prov_<ULID>).
network — required. One of bank, mobile_money.
account_number — required. For network = "mobile_money" this field carries the phone number; for network = "bank" it carries the bank account number.
account_name — required, except for network = "bank" in currencies where GlobalStack resolves the account name from the bank (currently NGN). In those cases account_name is optional and, if supplied, is discarded in favour of the bank-resolved value. For every other (network, currency) combination the supplied account_name is what we persist and pass to payout, so it is required.

Body — crypto fields (`type = "crypto"`)

network — required. One of solana, base, ethereum.
address — required. Max 128 chars.

Example — fiat (bank)

POST /v1/beneficiaries
{
  "type": "fiat",
  "name": "Alice Bank Beneficiary",
  "label": "Alice's salary account",
  "currency": "NGN",
  "country_code": "NG",
  "network": "bank",
  "account_number": "0039415616",
  "provider_id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4"
}

Example — crypto (USDC on Solana)

POST /v1/beneficiaries
{
  "type": "crypto",
  "name": "Alice Wallet",
  "label": "Personal cold wallet",
  "currency": "USDC",
  "network": "solana",
  "address": "9wFFa…"
}

POST

beneficiaries

Create a beneficiary

curl --request POST \
  --url https://api.globalstack.io/v1/beneficiaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "label": "<string>",
  "currency": "<string>",
  "network": "<string>",
  "metadata": {},
  "merchant_reference": "<string>",
  "customer_id": "<string>",
  "country_code": "<string>",
  "provider_id": "<string>",
  "account_number": "<string>",
  "account_name": "<string>",
  "address": "<string>"
}
'

import requests

url = "https://api.globalstack.io/v1/beneficiaries"

payload = {
    "name": "<string>",
    "label": "<string>",
    "currency": "<string>",
    "network": "<string>",
    "metadata": {},
    "merchant_reference": "<string>",
    "customer_id": "<string>",
    "country_code": "<string>",
    "provider_id": "<string>",
    "account_number": "<string>",
    "account_name": "<string>",
    "address": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    label: '<string>',
    currency: '<string>',
    network: '<string>',
    metadata: {},
    merchant_reference: '<string>',
    customer_id: '<string>',
    country_code: '<string>',
    provider_id: '<string>',
    account_number: '<string>',
    account_name: '<string>',
    address: '<string>'
  })
};

fetch('https://api.globalstack.io/v1/beneficiaries', 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.globalstack.io/v1/beneficiaries",
  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([
    'name' => '<string>',
    'label' => '<string>',
    'currency' => '<string>',
    'network' => '<string>',
    'metadata' => [
        
    ],
    'merchant_reference' => '<string>',
    'customer_id' => '<string>',
    'country_code' => '<string>',
    'provider_id' => '<string>',
    'account_number' => '<string>',
    'account_name' => '<string>',
    'address' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.globalstack.io/v1/beneficiaries"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"network\": \"<string>\",\n  \"metadata\": {},\n  \"merchant_reference\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"provider_id\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"address\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.globalstack.io/v1/beneficiaries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"network\": \"<string>\",\n  \"metadata\": {},\n  \"merchant_reference\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"provider_id\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"address\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.globalstack.io/v1/beneficiaries")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"label\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"network\": \"<string>\",\n  \"metadata\": {},\n  \"merchant_reference\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"provider_id\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"account_name\": \"<string>\",\n  \"address\": \"<string>\"\n}"

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

{
  "status": true,
  "message": "Beneficiary created successfully",
  "code": "ok",
  "data": {
    "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
    "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
    "name": "Alice Bank Beneficiary",
    "type": "fiat",
    "currency": "NGN",
    "details": {
      "country_code": "NG",
      "network": "bank",
      "account_number": "0039415616",
      "provider": {
        "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
        "name": "Access Bank",
        "code": "000014"
      },
      "account_name": "ALICE JOHNSON"
    },
    "metadata": {},
    "status": "pending",
    "created_at": "2026-04-16T16:14:08.000Z",
    "updated_at": "2026-04-16T16:14:08.000Z",
    "label": "Alice's salary account",
    "merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

{
  "status": false,
  "message": "Resource not found",
  "code": "not_found",
  "data": null,
  "meta": {
    "next_steps": {
      "action": "Verify the resource identifier and retry.",
      "docs_url": "https://docs.globalstack.io/errors#not_found"
    },
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Authorizations

Authorization

string

header

required

API key issued during merchant onboarding.

Body

application/json

CreateBeneficiaryDto

type

enum<string>

required

Available options:

fiat,

crypto

name

string

required

Required string length: 1 - 255

label

string

required

Required string length: 1 - 128

currency

string

required

Pattern: ^[A-Z0-9]{2,8}$

network

string

required

Minimum string length: 1

metadata

object

merchant_reference

string

Maximum string length: 128

customer_id

string

Pattern: ^cust_[0-9A-HJKMNP-TV-Z]{26}$

country_code

string

Pattern: ^[A-Z]{2}$

provider_id

string

Pattern: ^prov_[0-9A-HJKMNP-TV-Z]{26}$

account_number

string

Required string length: 1 - 64

account_name

string

Maximum string length: 255

address

string

Required string length: 1 - 128

Response

Beneficiary created successfully

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Beneficiary created successfully"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object

required

Show child attributes

Wallets

Transfers

Transactions

Quotes

Onramps

Offramps

Notification Webhooks

Customers

Me

Supported Currencies

Supported Countries

Conversions

Beneficiaries

Create a beneficiary

Body — shared fields

Body — fiat fields (`type = "fiat"`)

Body — crypto fields (`type = "crypto"`)

Example — fiat (bank)

Example — crypto (USDC on Solana)

Authorizations

Body

Response