Create Payout Link
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payout-links \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 0
}'
{
"amount": "number",
"claimed_user_id": "string",
"created": "string",
"delivery": {
"country_code": "string",
"email": "string",
"method": "link",
"phone_number": "string"
},
"flow_id": "string",
"id": "string",
"link": "string",
"metadata": [
"string",
"object",
"null"
],
"payee": {
"country_code": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string"
},
"status": "sent",
"tax_exempt": "boolean"
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
Array of steps in the flow.
compliance
, id-verification
, background-check
, manage-payments
, manage-payouts
, payout
, redirect
Amount to be paid in cents.
Force the collection of 1099 or W-8 information. Defaults to false
.
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.
Add a memo to the top of the Payout Link
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.
The payee. This is optional.
Overrides the setting for which party will pay fees on this payout. This takes precedence over the default for your application.
user
, platform
Payout links marked as tax_exempt
will not be counted towards the 1099 threshold.
The user's id.
Response
The amount to pay in cents.
ID of the user
that has claimed the payout-link
.
Date the payout-link
was created.
ID of the payout flow UI that is sent to the user.
ID of the payout-link
.
URL to access the payout-link
.
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.
Information about the payee. It is used to pre-fill information.
Status of the payout-link
.
sent
, claimed
, delivery_pending
, delivery_failed
, delivered
, canceled
Transfers marked as tax_exempt
will not be counted towards the 1099 threshold.
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payout-links \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 0
}'
{
"amount": "number",
"claimed_user_id": "string",
"created": "string",
"delivery": {
"country_code": "string",
"email": "string",
"method": "link",
"phone_number": "string"
},
"flow_id": "string",
"id": "string",
"link": "string",
"metadata": [
"string",
"object",
"null"
],
"payee": {
"country_code": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string"
},
"status": "sent",
"tax_exempt": "boolean"
}