Dots home pagelight logo
  1. Payout Links
  2. Create Payout Link
POST

/api/v2/payout-links

client_id*
api_key*
curl --request POST \
     --url https://api.senddotssandbox.com/api/v2/payout-links \
     --header 'Authorization: Basic AUTH_VALUE' \
     --header 'Content-Type: application/json' \
     --data '{
 "amount": integer
}'

​
Body

user_id
string

The user's id.

payee
object

The payee. This is optional.

amountRequired
integer

Amount to be paid in cents.

delivery
object
force_collect_compliance_information
boolean

Force the collection of 1099 or W-8 information. Defaults to false.

metadata
string | object

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.

memo
string

Add a memo to the top of the Payout Link

​
Response

id
string

ID of the payout-link.

created
string

Date the payout-link was created.

link
string

URL to access the payout-link.

amount
number

The amount to pay in cents.

status
string

Status of the payout-link.

Available options: claimed, delivery_pending, delivery_failed, delivered, canceled
payee
object

Information about the payee. It is used to pre-fill information.

delivery
object
tax_exempt
boolean

Transfers marked as tax_exempt will not be counted towards the 1099 threshold.

claimed_user_id
string

ID of the user that has claimed the payout-link.

metadata
string | object | null

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.