Payout wallets

List the other wallets your account has saved, so a payment link or invoice can pay one of them instead of your main payout wallet.

On this page

The payout wallet object

Every sale settles to your account's payout wallet. An owner can save other wallets beside it in the dashboard under Settings → Payout wallet, and a payment link or an invoice can pay one of them: send its id as payout_wallet_id. This endpoint lists those wallets, so your code can find the id without anyone copying it from the dashboard.

FieldTypeDescription
idstringThe wallet's id, pw_…: what payout_wallet_id takes
objectstring"payout_wallet"
networkstringevm for a wallet on Polygon and the other EVM networks, the kind a payment link or invoice can pay. Any other value, such as bitcoin, tron or solana, is a wallet for crypto payments in that network's coins
addressstringThe wallet's address, in its network's own form
labelstring or nullThe owner's name for an evm wallet, such as Wholesale. null for a wallet on another network
usablebooleantrue when a Live payment link or invoice can pay this wallet today. false for a wallet on another network, and for one the wallet checks refuse; naming it in Live mode is 409 payout_wallet_unusable
createdintegerWhen it was saved, in Unix seconds

List payout wallets

GET /v1/payout_wallets

Returns every wallet your account has saved, newest first. Saved wallets aren't per mode, so a Test key and a Live key read the same list. An account keeps at most ten evm wallets and one for each other network, so the list comes in one page: has_more is always false and there are no parameters.

curl https://pay.railbed.io/v1/payout_wallets \
  -H "Authorization: Bearer $RAILBED_SECRET_KEY"
Response
{
  "data": [
    {
      "id": "pw_Wh7kQ2nVx9RtZ4mLp6Cb",
      "object": "payout_wallet",
      "network": "evm",
      "address": "0x7a1c4e9b2d5f8a3c6e0b1d4f7a9c2e5b8d0f3a6c",
      "label": "Wholesale",
      "usable": true,
      "created": 1790380525
    }
  ],
  "has_more": false,
  "next_cursor": null
}
200 OK

An account with no other wallets gets an empty data. A removed wallet leaves the list at once, and a new payment link or invoice that names it is 400 invalid_payout_wallet.

Access

This endpoint needs the payments:read scope, which every secret key has, Read only keys included, and connected AI agents too.

Updated · This page as Markdown