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.
curl --request POST \
--url https://api.dots.dev/api/v2/payouts/send-payout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payee": {
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"message": "<string>"
},
"force_collect_compliance_information": false,
"additional_steps": [
"compliance"
],
"tax_exempt": true,
"metadata": "<string>",
"memo": "<string>",
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payout_fee_party": "user",
"accounting_data": {
"quickbooks_account_id": 123,
"quickbooks_class_id": 123
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"link": "<string>",
"amount": 123,
"status": "created",
"payee": {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"method": "link",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"tax_exempt": true,
"claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<string>"
}
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Created
The payout-link
object.
Was this page helpful?
curl --request POST \
--url https://api.dots.dev/api/v2/payouts/send-payout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payee": {
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"message": "<string>"
},
"force_collect_compliance_information": false,
"additional_steps": [
"compliance"
],
"tax_exempt": true,
"metadata": "<string>",
"memo": "<string>",
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payout_fee_party": "user",
"accounting_data": {
"quickbooks_account_id": 123,
"quickbooks_class_id": 123
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"link": "<string>",
"amount": 123,
"status": "created",
"payee": {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"method": "link",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"tax_exempt": true,
"claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<string>"
}
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.
curl --request POST \
--url https://api.dots.dev/api/v2/payouts/send-payout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payee": {
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"message": "<string>"
},
"force_collect_compliance_information": false,
"additional_steps": [
"compliance"
],
"tax_exempt": true,
"metadata": "<string>",
"memo": "<string>",
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payout_fee_party": "user",
"accounting_data": {
"quickbooks_account_id": 123,
"quickbooks_class_id": 123
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"link": "<string>",
"amount": 123,
"status": "created",
"payee": {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"method": "link",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"tax_exempt": true,
"claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<string>"
}
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Created
The payout-link
object.
Was this page helpful?
curl --request POST \
--url https://api.dots.dev/api/v2/payouts/send-payout \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payee": {
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"message": "<string>"
},
"force_collect_compliance_information": false,
"additional_steps": [
"compliance"
],
"tax_exempt": true,
"metadata": "<string>",
"memo": "<string>",
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payout_fee_party": "user",
"accounting_data": {
"quickbooks_account_id": 123,
"quickbooks_class_id": 123
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"link": "<string>",
"amount": 123,
"status": "created",
"payee": {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"delivery": {
"method": "link",
"email": "jsmith@example.com",
"country_code": "<string>",
"phone_number": "<string>"
},
"tax_exempt": true,
"claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<string>"
}