Skip to main content
Input object One endpoint (the source or destination) of a bulk transfer. Set EXACTLY ONE of operator or externalReferenceId: operator true means your application’s configured payout account; externalReferenceId names a connected user. Both-set or neither-set is rejected.

Input fields

Boolean
Set true to use your application’s operator payout account as this endpoint. Mutually exclusive with externalReferenceId.
String
The externalReferenceId of a connected user to use as this endpoint. Mutually exclusive with operator.
UUID
The user’s spend account for this side of the transfer. Only valid alongside externalReferenceId (the operator endpoint’s account is fixed by your payout configuration). Required when the item would otherwise be ambiguous — a source user whose grant permits several spend accounts, or a destination user with several accounts at the source’s sponsor bank and no default. Omitted, it defaults to the single eligible account, else the user’s default one.