Payout Destination
Manage payout destinations for bank transfers and USDT withdrawals. Supports bank account details and wallet addresses with optional labels for easy identification and search.
Get the paginated, active payout destinations of the user
Returns the payout destinations created by the authenticated user, optionally filtered by beneficiary. Only ACTIVE destinations are returned; superseded ones are excluded. The scope is implicit to the authenticated user: a beneficiaryId belonging to another user returns an empty list rather than a 404.
Create a payout destination for a beneficiary
Creates a payout destination representing an account belonging to a beneficiary that can be used as the target of a payout. A beneficiary can have a payout destination associated with their account details for receiving payouts.
Edit an active payout destination
Edits any field of an active payout destination except `beneficiaryId`, which cannot be changed. Past transfers keep a snapshot of the destination as it was at the time of the transfer, so editing a destination never affects historical transfers.
Get the field requirements for one or more payout destination rails
Returns the fields required to create a payout destination for each requested rail, so the frontend can build the creation form dynamically instead of hardcoding rail-specific rules. Returns every rail when no filter is provided.
Get a payout destination by ID
Returns a payout destination owned by the authenticated user. Unlike the list endpoint, this also returns SUPERSEDED destinations, since the status filter is a listing concern, not a detail one.