Pay-out

For complete API specification, see the API Reference.

Send cryptocurrency from customer wallets to any external wallet address.

Create Payout

Not authenticated•Authenticate first

Request Parameters

From (Customer ID or Wallet ID)

To Address

Amount

Blockchain Network

Source Rail

Destination Rail

POST/v1/payout

Copy as

Sends cryptocurrency from a customer's wallet to an external blockchain address.

Request Format

The payout endpoint accepts two identifier formats in from.id:

Format	Example	Rail Required?	Description
Wallet ID	`wal_abc123`	No	Directly specify the wallet. Rail is inferred from the wallet's network.
Customer ID	`cus_abc123`	Yes	The system finds the customer's wallet matching the specified `from.rail`.

Using Wallet ID is simpler — you don't need to specify the rail since it's inferred from the wallet itself.

Examples

With Wallet ID (recommended):

{
  "from": {
    "id": "wal_abc123",
    "amount": 50
  },
  "to": {
    "id": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "rail": "polygon"
  }
}

With Customer ID:

{
  "from": {
    "id": "cus_abc123",
    "rail": "polygon",
    "amount": 50
  },
  "to": {
    "id": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "rail": "polygon"
  }
}

Common Errors

Status	Error	Description
`400`	Insufficient balance for this payout	Customer wallet balance is too low for the requested payout amount
`400`	Rail is required when using customer ID	Must specify `from.rail` when using a customer ID
`400`	Off-ramp will be supported soon	Fiat rails are not yet supported for payouts (crypto only)
`404`	Wallet not found	Specified wallet ID does not exist
`404`	Customer not found	Specified customer ID does not exist
`404`	No wallet found for specified rail	Customer does not have a wallet on the specified blockchain network
`400`	Invalid currency	Specified currency is not supported

Create Payout

Request Format

Examples

Common Errors

On this page