- Documentation
- API Reference
- GitHub
Apps
Flows
Payouts
Payout Links
Payout Requests
Transfers
Transfer Batches
Transactions
Users
Checkout Sessions
Disputes
Refunds
Payments
Payment Customers
Payment Intents
Payment Methods
Core Resources
Payments
Create a Payout Request
Create a Payout Request that can be approved on the Dots Dashboard.
curl --request POST \
--url https://api.dots.dev/api/v2/payout-requests \
--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>"
},
"metadata": "<string>",
"memo": "<string>"
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"amount": 123,
"status": "created",
"payee": {
"country_code": "<string>",
"phone_number": "<string>"
},
"payout-link": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"link": "<string>",
"amount": 123,
"status": "sent",
"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",
"description": "<string>",
"accounting_data": {
"quickbooks_account_id": 123
},
"metadata": "<string>"
},
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"phone_number": {
"country_code": "<string>",
"phone_number": "<string>"
},
"wallet": {
"amount": 123,
"withdrawable_amount": 123,
"credit_balance": 123
},
"compliance": {
"tax_id_collected": true,
"address_collected": true,
"date_of_birth_collected": true,
"must_collect_1099": true,
"1099_collected": true,
"w8_ben_collected": true,
"flagged": true,
"id_verified": true
},
"default_payout_method": "paypal",
"auto_payout_enabled": true,
"metadata": "<string>"
},
"metadata": "<string>",
"memo": "<string>"
}
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.
The user's id. user_id
or payee
is required.
The payee's phone number. user_id
or payee
is required.
Country code of the payee's phone number e.g. "1" for USA.
Rest of the payee's phone number.
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 payout request
Response
ID of the payout-request
.
Date that the payout-request
was created.
Amount in cents of the payout-request
.
Status of the payout-request
.
created
, approved
, rejected
The payout-link
that was sent when the payout-request
was approved.
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
.
sent
, claimed
, delivery_pending
, delivery_failed
, delivered
, canceled
Information about the payee. It is used to pre-fill information.
Payee's first name.
Payee's last name.
Payee's email address.
Country code of the payee's phone number e.g. "1" for USA.
Rest of the payee's phone number.
link
, sms
, email
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.
Description of the transaction displayed in the dashboard and in accounting software.
Optional data used by accounting software integrations.
ID of the Quickbooks Online account to sync this transaction to, overriding the defaults configured in the dashboard.
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 user
that requested the payout.
Configures the user's default payout method. Must be a payout method already configured by the user.
paypal
, venmo
, cash_app
, ach
, intl_bank
, airtm
, payoneer
Enables auto payout for the user whenever a default payout method is defined
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.
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.
curl --request POST \
--url https://api.dots.dev/api/v2/payout-requests \
--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>"
},
"metadata": "<string>",
"memo": "<string>"
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"amount": 123,
"status": "created",
"payee": {
"country_code": "<string>",
"phone_number": "<string>"
},
"payout-link": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"link": "<string>",
"amount": 123,
"status": "sent",
"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",
"description": "<string>",
"accounting_data": {
"quickbooks_account_id": 123
},
"metadata": "<string>"
},
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"phone_number": {
"country_code": "<string>",
"phone_number": "<string>"
},
"wallet": {
"amount": 123,
"withdrawable_amount": 123,
"credit_balance": 123
},
"compliance": {
"tax_id_collected": true,
"address_collected": true,
"date_of_birth_collected": true,
"must_collect_1099": true,
"1099_collected": true,
"w8_ben_collected": true,
"flagged": true,
"id_verified": true
},
"default_payout_method": "paypal",
"auto_payout_enabled": true,
"metadata": "<string>"
},
"metadata": "<string>",
"memo": "<string>"
}