Skip to main content
Input object Destination detail for a payout transfer. createPayout is authenticated with the operator’s application (Basic auth) credentials, so the receiving user must be named explicitly via externalReferenceId (the operator’s own identifier for that user, established when the user granted this application access).

​
Input fields

​
String!
required
Required. The operator’s external reference id for the user who will receive the payout. The user must have granted this application the scope required by the payoutType (see below); that grant is what authorizes the destination leg — no live user token is involved.
​
UUID
Target a specific cash balance on the destination user’s account. Must belong to that account. If omitted, the system resolves the appropriate cash balance automatically.