Skip to main content
POST
/
v1
/
recipients
Create a new recipient (crypto or fiat)
curl --request POST \
  --url https://api.railsfromthecrypt.com/v1/recipients \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "type": "crypto",
  "name": "My USDT Wallet",
  "wallet_address": "0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e",
  "network": "Polygon",
  "symbol": "USDT"
}
'
{
  "message": "Recipient created successfully",
  "data": {
    "id": "rec_01J8V9ZP3A7",
    "type": "crypto",
    "name": "Vendor Payment",
    "active": true,
    "details": {
      "network": "Polygon",
      "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”

Headers

​
x-api-key
string
required

API key for authentication

​
x-idempotency-key
string

Idempotency key for the create recipient request

Example:

"1234567890-1234567890-1234567890"

Body

application/json

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:
Polygon,
Ethereum,
BSC,
Arbitrum,
TRC20
Example:

"Polygon"

​
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