Create Recipient

Create a new recipient (crypto or fiat)

curl --request POST \
  --url https://api.staging.railsfromthecrypt.com/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "crypto",
  "name": "My USDT Wallet",
  "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
  "network": "Ethereum",
  "symbol": "USDT"
}
'

import requests

url = "https://api.staging.railsfromthecrypt.com/v1/recipients"

payload = {
    "type": "crypto",
    "name": "My USDT Wallet",
    "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
    "network": "Ethereum",
    "symbol": "USDT"
}
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({
    type: 'crypto',
    name: 'My USDT Wallet',
    wallet_address: '0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e',
    network: 'Ethereum',
    symbol: 'USDT'
  })
};

fetch('https://api.staging.railsfromthecrypt.com/v1/recipients', 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.staging.railsfromthecrypt.com/v1/recipients",
  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([
    'type' => 'crypto',
    'name' => 'My USDT Wallet',
    'wallet_address' => '0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e',
    'network' => 'Ethereum',
    'symbol' => 'USDT'
  ]),
  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.staging.railsfromthecrypt.com/v1/recipients"

	payload := strings.NewReader("{\n  \"type\": \"crypto\",\n  \"name\": \"My USDT Wallet\",\n  \"wallet_address\": \"0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e\",\n  \"network\": \"Ethereum\",\n  \"symbol\": \"USDT\"\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.staging.railsfromthecrypt.com/v1/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"crypto\",\n  \"name\": \"My USDT Wallet\",\n  \"wallet_address\": \"0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e\",\n  \"network\": \"Ethereum\",\n  \"symbol\": \"USDT\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.railsfromthecrypt.com/v1/recipients")

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  \"type\": \"crypto\",\n  \"name\": \"My USDT Wallet\",\n  \"wallet_address\": \"0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e\",\n  \"network\": \"Ethereum\",\n  \"symbol\": \"USDT\"\n}"

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

{
  "message": "Recipient created successfully",
  "data": {
    "id": "rec_01J8V9ZP3A7",
    "type": "crypto",
    "name": "Vendor Payment",
    "active": true,
    "details": {
      "network": "Ethereum",
      "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
      "symbol": "USDT"
    },
    "created_at": "2025-10-10T09:15:21Z"
  }
}

POST

recipients

Create a new recipient (crypto or fiat)

curl --request POST \
  --url https://api.staging.railsfromthecrypt.com/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "crypto",
  "name": "My USDT Wallet",
  "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
  "network": "Ethereum",
  "symbol": "USDT"
}
'

import requests

url = "https://api.staging.railsfromthecrypt.com/v1/recipients"

payload = {
    "type": "crypto",
    "name": "My USDT Wallet",
    "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
    "network": "Ethereum",
    "symbol": "USDT"
}
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({
    type: 'crypto',
    name: 'My USDT Wallet',
    wallet_address: '0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e',
    network: 'Ethereum',
    symbol: 'USDT'
  })
};

fetch('https://api.staging.railsfromthecrypt.com/v1/recipients', 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.staging.railsfromthecrypt.com/v1/recipients",
  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([
    'type' => 'crypto',
    'name' => 'My USDT Wallet',
    'wallet_address' => '0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e',
    'network' => 'Ethereum',
    'symbol' => 'USDT'
  ]),
  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.staging.railsfromthecrypt.com/v1/recipients"

	payload := strings.NewReader("{\n  \"type\": \"crypto\",\n  \"name\": \"My USDT Wallet\",\n  \"wallet_address\": \"0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e\",\n  \"network\": \"Ethereum\",\n  \"symbol\": \"USDT\"\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.staging.railsfromthecrypt.com/v1/recipients")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"crypto\",\n  \"name\": \"My USDT Wallet\",\n  \"wallet_address\": \"0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e\",\n  \"network\": \"Ethereum\",\n  \"symbol\": \"USDT\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.railsfromthecrypt.com/v1/recipients")

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  \"type\": \"crypto\",\n  \"name\": \"My USDT Wallet\",\n  \"wallet_address\": \"0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e\",\n  \"network\": \"Ethereum\",\n  \"symbol\": \"USDT\"\n}"

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

{
  "message": "Recipient created successfully",
  "data": {
    "id": "rec_01J8V9ZP3A7",
    "type": "crypto",
    "name": "Vendor Payment",
    "active": true,
    "details": {
      "network": "Ethereum",
      "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
      "symbol": "USDT"
    },
    "created_at": "2025-10-10T09:15:21Z"
  }
}

Create and manage payout and settlement destinations for your account. HashRails supports two recipient types:

Bank account - settle to a local bank account
Crypto - settle in USDC or USDT to a wallet address

Crypto Recipients

For crypto recipients, you need:

wallet_address - Ethereum wallet address (required for crypto)
network - Blockchain network (e.g., Polygon, Ethereum)
symbol - Cryptocurrency symbol (e.g., USDC, USDT)

Fiat Recipients

For fiat recipients, you need:

account_number - Bank account number (10 digits)
bank_code - Bank code (get available codes from Get Banks)
currency - Fiat currency (e.g., NGN, USD, EUR)

Common Fields

Both types require:

name - Recipient name
type - Either “crypto” or “fiat”

Authorizations

Authorization

string

header

required

JWT access token from POST /v1/auth/token/issue. Send as: Authorization: Bearer <access_token>

Headers

x-idempotency-key

string

Idempotency key for the create recipient request

Example:

"1234567890-1234567890-1234567890"

Body

application/json

Crypto Recipient
Fiat Recipient

Create a crypto recipient to receive settlement in USDC or USDT.

type

enum<string>

required

Recipient type.

Available options:

crypto

Example:

"crypto"

name

string

required

A label for this recipient.

Example:

"My USDT Wallet"

wallet_address

string

required

The destination wallet address.

Example:

"0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e"

network

enum<string>

required

Blockchain network for settlement.

Available options:

Ethereum,

BSC,

Tron

Example:

"Ethereum"

symbol

enum<string>

required

Cryptocurrency to settle in.

Available options:

USDC,

USDT

Example:

"USDT"

Response

201 - application/json

Recipient created successfully

message

string

Example:

"Recipient created successfully"

data

object

Option 1
Option 2

Show child attributes

Getting Started

Authentication

Recipients

Transfer Request

Transactions

Banks

Crypto Recipients

Fiat Recipients

Common Fields

Authorizations

Headers

Body

Response

​Crypto Recipients

​Fiat Recipients

​Common Fields

Authorizations

Headers

Body

Response

Crypto Recipients

Fiat Recipients

Common Fields