# dots api API

> dots api API on Apizie: 65 endpoints (List all Users, Create a User, Retrieve a User, Update a user, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:dots/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:dots`
- Category: Payments
- Status: byok
- Source: https://dots.dev
- Page: https://apizie.tech/api/payments/dots
- OpenAPI: https://apizie.tech/api/payments/dots/openapi.json

Scalable and Flexible Payouts Infrastructure

## Endpoints

### List all Users
`GET https://apizie.tech/v1/payments:dots/users-list-all-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 100. |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a User
`POST https://apizie.tech/v1/payments:dots/users-create-new-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a User
`GET https://apizie.tech/v1/payments:dots/users-get-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |

### Update a user
`POST https://apizie.tech/v1/payments:dots/users-update-user-object` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |
| body | object | no | JSON request body |

### Delete a User
`POST https://apizie.tech/v1/payments:dots/users-remove-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |

### Submit Compliance Information
`POST https://apizie.tech/v1/payments:dots/users-submit-compliance-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |
| body | object | no | JSON request body |

### Send a Verification Token
`POST https://apizie.tech/v1/payments:dots/users-send-verification-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |
| body | object | no | JSON request body |

### Verify a User
`POST https://apizie.tech/v1/payments:dots/users-verify-user-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |
| body | object | no | JSON request body |

### List Payout Methods
`GET https://apizie.tech/v1/payments:dots/users-list-payout-methods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |

### Add a Payout Method
`POST https://apizie.tech/v1/payments:dots/users-add-payout-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | Id of the user to fetch |
| body | object | no | JSON request body |

### List all Transfers
`GET https://apizie.tech/v1/payments:dots/transfers-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |
| user_id | string | no | Include only results with this user ID attached. |

### Create a Transfer
`POST https://apizie.tech/v1/payments:dots/transfers-create-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a Transfer
`GET https://apizie.tech/v1/payments:dots/transfers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transfer_id | string | yes | Id of the transfer to fetch |

### List all Flows
`GET https://apizie.tech/v1/payments:dots/flows-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a Flow
`POST https://apizie.tech/v1/payments:dots/flows-create-new-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Flow
`GET https://apizie.tech/v1/payments:dots/flows-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| flow_id | string | yes | Id of the flow to fetch |

### List all Payout Links
`GET https://apizie.tech/v1/payments:dots/payoutlinks-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a Payout Link
`POST https://apizie.tech/v1/payments:dots/payoutlinks-create-payout-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Payout Link
`GET https://apizie.tech/v1/payments:dots/payoutlinks-get-payout-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payout_link_id | string | yes | Id of the payout link |

### Delete a Payout Link
`POST https://apizie.tech/v1/payments:dots/payoutlinks-cancel-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payout_link_id | string | yes | Id of the payout link |

### Create a Payout
`POST https://apizie.tech/v1/payments:dots/payouts-create-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create a Payment
`POST https://apizie.tech/v1/payments:dots/payments-create-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Send a Payout
`POST https://apizie.tech/v1/payments:dots/payouts-send-payout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List all Payout Requests
`GET https://apizie.tech/v1/payments:dots/payoutrequests-get-all-payouts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a Payout Request
`POST https://apizie.tech/v1/payments:dots/payoutrequests-submit-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Payout Request
`GET https://apizie.tech/v1/payments:dots/payoutrequests-get-payout-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payout_request_id | string | yes | Id of the payout request |

### List all Transactions
`GET https://apizie.tech/v1/payments:dots/transactions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Retrieve a Transaction
`GET https://apizie.tech/v1/payments:dots/transactions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | yes | Id of the transaction |

### List all Payment Intents
`GET https://apizie.tech/v1/payments:dots/paymentintents-list-all` (byok)

### Create a Payment Intent
`POST https://apizie.tech/v1/payments:dots/paymentintents-create-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Payment Intent
`GET https://apizie.tech/v1/payments:dots/paymentintents-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment_intent_id | string | yes | Payment Intent ID |

### Confirm a Payment Intent
`POST https://apizie.tech/v1/payments:dots/paymentintents-confirm-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment_intent_id | string | yes | The ID if the Payment Intent to confirm. |
| body | object | no | JSON request body |

### List all Transfer Batches
`GET https://apizie.tech/v1/payments:dots/transferbatches-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a Transfer Batch
`POST https://apizie.tech/v1/payments:dots/transferbatches-create-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Transfer Batch
`GET https://apizie.tech/v1/payments:dots/transferbatches-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transfer_batch_id | string | yes | Id of the transfer batch to fetch |

### List all Payment Customers
`GET https://apizie.tech/v1/payments:dots/paymentcustomers-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a Payment Customer
`POST https://apizie.tech/v1/payments:dots/paymentcustomers-create-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Payment Customer
`GET https://apizie.tech/v1/payments:dots/paymentcustomers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment_customer_id | string | yes | The ID of the payment customer |

### List all Checkout Sessions
`GET https://apizie.tech/v1/payments:dots/checkoutsessions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a Checkout Session
`POST https://apizie.tech/v1/payments:dots/checkoutsessions-create-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Checkout Session
`GET https://apizie.tech/v1/payments:dots/checkoutsessions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| checkout_session_id | string | yes | ID of the checkout session to retrieve |

### List all Apps
`GET https://apizie.tech/v1/payments:dots/apps-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to retrieve |
| starting_after | string | no | ID of first app to retrieve |
| ending_before | string | no | ID of last app to retrieve |

### Create an App
`POST https://apizie.tech/v1/payments:dots/apps-create-new-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve an App
`GET https://apizie.tech/v1/payments:dots/apps-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | ID of the app to retrieve |

### Retrieve an App's Compliance Information
`GET https://apizie.tech/v1/payments:dots/apps-get-compliance-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | ID of the app to query or modify |

### Update an App's Compliance Information
`POST https://apizie.tech/v1/payments:dots/apps-update-compliance-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | ID of the app to query or modify |
| body | object | no | JSON request body |

### Get App ACH Account
`GET https://apizie.tech/v1/payments:dots/apps-get-ach-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | The ID of the app. |

### Add App ACH Account
`POST https://apizie.tech/v1/payments:dots/apps-add-ach-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | The ID of the app. |
| body | object | no | JSON request body |

### Deposit Funds into App Wallet
`POST https://apizie.tech/v1/payments:dots/apps-deposit-funds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | The ID of the App. |
| body | object | no | JSON request body |

### Withdraw Funds From App Wallet
`POST https://apizie.tech/v1/payments:dots/apps-withdraw-funds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_id | string | yes | The ID of the App. |
| body | object | no | JSON request body |

### List all Payment Methods for a Payment Customer
`GET https://apizie.tech/v1/payments:dots/paymentmethods-list-all-payment-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customer_id | string | no | Payment Customer ID |
| limit | number | no | Number or payment methods to return |

### Retrieve a Payment Method
`GET https://apizie.tech/v1/payments:dots/paymentmethods-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment_method_id | string | yes | ID of the payment method to get |

### Attach a Payment Method to a Payment Customer
`POST https://apizie.tech/v1/payments:dots/paymentmethods-attach-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment_method_id | string | yes | The ID of the payment method. |
| body | object | no | JSON request body |

### Detach Payment Method from a Payment Customer
`POST https://apizie.tech/v1/payments:dots/paymentmethods-detach-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| payment_method_id | string | yes | ID of the payment method. |
| body | object | no | JSON request body |

### List all Disputes
`GET https://apizie.tech/v1/payments:dots/disputes-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Retrieve a Dispute
`GET https://apizie.tech/v1/payments:dots/disputes-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dispute_id | string | yes | ID of the dispute to retrieve |

### Add Evidence to a Dispute
`POST https://apizie.tech/v1/payments:dots/disputes-add-evidence-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dispute_id | string | yes | ID of the dispute to add evidence to |
| body | object | no | Form fields as a JSON object |

### Submit a Dispute
`POST https://apizie.tech/v1/payments:dots/disputes-submit-dispute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dispute_id | string | yes | ID of the dispute to submit |
| body | object | no | JSON request body |

### List all Refunds
`GET https://apizie.tech/v1/payments:dots/refunds-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |

### Create a Refund
`POST https://apizie.tech/v1/payments:dots/refunds-create-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Refund
`GET https://apizie.tech/v1/payments:dots/refunds-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| refund_id | string | yes | ID of the refund to retrieve |

### List all Organization Transfers
`GET https://apizie.tech/v1/payments:dots/transfers-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 100. |
| starting_after | string | no | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list… |
| ending_before | string | no | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list… |
| user_id | string | no | Include only results with this user ID attached. |

### Create an Organization Transfer
`POST https://apizie.tech/v1/payments:dots/transfers-create-organization-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a Transfer
`GET https://apizie.tech/v1/payments:dots/transfers-get-by-id-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transfer_id | string | yes | ID of the transfer to retrieve |

### Add User Address
`POST https://apizie.tech/v1/payments:dots/users-update-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | The ID of the user |
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/payments:dots/users-list-all-users" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the dots api API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:dots/users-list-all-users with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the dots api API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. dots api itself also needs your own key from api.dots.dev.

### Can AI agents use the dots api API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:dots.

### What is the status of the dots api API?
Needs your own provider key (bring your own key)