users
transfers
payout-links
payments
payment-intents
payment-customers
checkout-sessions
accounts-payable
- GETList all vendors
- POSTCreate a vendor
- GETGet vendor details
- DELDelete a vendor
- GETList all payment methods for a vendor
- POSTCreate a payment method for a vendor
- GETGet vendor payment method details
- DELDelete a vendor payment method
- GETList all payables
- POSTCreate a payable
- POSTCreate a payable from a file
- GETGet payable details
- PATCHUpdate a payable
- POSTUpload file to the payable
- DELDelete file from the payable
- POSTCancel a payable
- POSTSubmit a payable for approval
- POSTApprove a payable
- POSTReject a payable
- POSTPay a payable
- GETList all approval policies
- POSTCreate an approval policy
- DELDelete an approval policy
- PATCHUpdate priority of an approval policy
- GETList all approvers for api app
apps
payment-methods
organizations
Retrieve a Payout Request
Get a payout request by its id.
curl --request GET \
--url https://api.dots.dev/api/v2/payout-requests/{payout_request_id} \
--header 'Authorization: Basic <encoded-value>'{
"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": "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>"
},
"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>"
},
"default_payout_method": "ach",
"default_payout_method_details": {
"id": "<string>",
"platform": "ach",
"description": "<string>",
"mask": "<string>",
"email": "<string>",
"phone_number": "<string>",
"cash_tag": "<string>",
"country": "<string>",
"currency": "<string>",
"rtp_enabled": true
},
"wallet": {
"amount": 123,
"withdrawable_amount": 123,
"credit_balance": 123
},
"status": "verified",
"compliance": {
"tax_id_collected": true,
"tax_id_verification": "unsubmitted",
"address_collected": true,
"date_of_birth_collected": true,
"must_collect_1099": true,
"1099_collected": true,
"w8_ben_collected": true,
"flagged": true,
"id_verified": true,
"has_criminal_activity": true,
"w9": "<any>",
"flags": {
"ofac": true,
"ofac_status": "unflagged",
"payout_method": true,
"payout_method_cycle": 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.
Path Parameters
Id of the payout request
Response
The payout-request id.
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.
created, delivery_pending, delivery_failed, sent, delivered, claimed, reversed, canceled, expired 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.
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.
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.
ach, paypal, venmo, cash_app, intl_bank, airtm, payoneer ach, paypal, venmo, cash_app, intl_transfer, airtm, payoneer ID of the payment-method.
Indicates if RTP is enabled for the payment method (applies to ach only).
verified, unverified, disabled, in_review Deprecated. Use w9.tax_id_collected instead.
Tax ID verification status. A mismatched tax ID may be corrected and resubmitted.
unsubmitted, pending, matched, mismatched Deprecated. Use w9.address_collected instead.
The user's date of birth was collected.
The user's 1099 information needs to be collected to resume payouts.
The user's 1099 information was collected.
The user's W8-BEN information was collected.
The user is flagged for review. For more information, see the flags object.
The user's id was verified.
The user has criminal activity based on a background check.
Information about the user's W9 form. null if the user is not a US individual or business.
True when the user is flagged for potential OFAC compliance issues.
Status of the user's OFAC compliance verification.
unflagged, id_verification_required, in_review, flagged True when two or more users share the same payout method.
True when the user has connected or disconnected payout methods repeatedly over a short period of time.
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 GET \
--url https://api.dots.dev/api/v2/payout-requests/{payout_request_id} \
--header 'Authorization: Basic <encoded-value>'{
"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": "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>"
},
"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>"
},
"default_payout_method": "ach",
"default_payout_method_details": {
"id": "<string>",
"platform": "ach",
"description": "<string>",
"mask": "<string>",
"email": "<string>",
"phone_number": "<string>",
"cash_tag": "<string>",
"country": "<string>",
"currency": "<string>",
"rtp_enabled": true
},
"wallet": {
"amount": 123,
"withdrawable_amount": 123,
"credit_balance": 123
},
"status": "verified",
"compliance": {
"tax_id_collected": true,
"tax_id_verification": "unsubmitted",
"address_collected": true,
"date_of_birth_collected": true,
"must_collect_1099": true,
"1099_collected": true,
"w8_ben_collected": true,
"flagged": true,
"id_verified": true,
"has_criminal_activity": true,
"w9": "<any>",
"flags": {
"ofac": true,
"ofac_status": "unflagged",
"payout_method": true,
"payout_method_cycle": true
}
},
"metadata": "<string>"
},
"metadata": "<string>",
"memo": "<string>"
}