Send a Payout
Send a payout to a person when you know their phone number or user id. If the user has a Dots acconut, the funds will delivered according to their saved prefernces. Otherwise, they will be sent a Payout Link to onboard and recieve funds.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The amount in cents to pay the user.
x > 0The user's id. user_id or payee is required.
The payee's phone number. user_id or payee is required.
Collect 1099 or w8-ben information.
Array of steps in the flow.
compliance, id-verification, background-check, manage-payments, manage-payouts, payout, redirect Payouts marked as tax_exempt will not be counted towards the 1099 threshold.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Add a memo to the top of the Payout Link
Unique UUID key that prevents duplicate requests from being processed. If a payout link with the idempotency key exists, a new link will not be created and the existing link will be returned instead.
Overrides the setting for which party will pay fees on this payout. This takes precedence over the default for your application.
user, platform Response
The payout-link object.
ID of the payout-link.
Date the payout-link was created.
URL to access the payout-link.
The amount to pay in cents.
Status of the payout-link.
created, delivery_pending, delivery_failed, sent, delivered, claimed, reversed, canceled, expired Information about the payee. It is used to pre-fill information.
Transfers marked as tax_exempt will not be counted towards the 1099 threshold.
ID of the user that has claimed the payout-link.
ID of the payout flow UI that is sent to the user.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.