amount
value. However, you have several other options available, which are described in the following table:Parameter | Description |
---|---|
user_id | The user’s id. |
payee | The payee. |
amount | REQUIRED. Amount to be paid in cents. |
delivery | Delivery information. |
delivery.message | Message to send in the SMS message that is sent to the payee. |
delivery.method | Delivery method. Options: sms , link , email , all . |
force_collect_compliance_information | Force the collection of 1099 or W-8 information. |
tax_exempt | Payout links marked as tax_exempt will not be counted towards the 1099 threshold. |
metadata | Set of key-value pairs that you can attach to an object. It is useful for storing additional information about the object in a structured format. |
memo | Add a memo to the top of the Payout Link. |
idempotency_key | Unique UUID key that prevents duplicate requests from being processed. |
payout_fee_party | Overrides the setting for which party will pay fees on this payout. |
additional_steps | Array of steps in the onboarding process. Options: compliance , id-verification , background-check , manage-payments , manage-payouts , payout , redirect . |
link
parameter in the response will provide the Payout Link you can share with the payee.