Create an address book recipient
Creates an address book recipient for crypto payouts. Use the returned id as destination.id when creating a payout.
Digital Asset Accounts: the address book is available only for custody accounts (purpose: custody) and is for third-party payouts only. It is not supported when the distributor or the end user is under the Circle FR (CIRCLE_FR) or Circle SG (CIRCLE_SG) legal entity. Set clientEntityId to the end user who owns the custody account you will pay out from. A payout can only use a recipient created for that end user.
POST
Create an address book recipient
Authorizations
Body
application/json
Blockchain network code for the recipient address (address book scope).
Available options:
ALGO, APTOS, ARB, ARC, AVAX, BASE, CELO, CODEX, CRONOS, EDGE, ETH, HBAR, HYPEREVM, INJECTIVE, INK, LINEA, MONAD, MORPH, NEAR, OP, PAH, PHAROS, PLASMA, PLUME, POLY, SEI, SOL, SONIC, STRK, SUI, UNI, WORLDCHAIN, XDC, XLAYER, XLM, XRP, ZKS