API Reference

GitHub

client_id:api_key

Dots

Get Started

Log in

Everything you need to know about users on the Dots Platform

Users Overview

Payouts, Payments, Onboarding, KYC, Background Checks, and more - all in one integration.

Introduction

Power your Platform with Dots

Core Concepts

Setup and Environments

Authentication

Error Codes

Metadata

Learn how to send your first payout using Dots.

Your First Payout

Guide to implenting Dots Drop-in Components (flows) into your application.

Dots Drop-in Components

Accept Card Payment

Accepting Card Payment using React

Apps Overview (Multi-tenancy)

Create an App

Retrieve an App

List all Apps

Add App Compliance Information

Retrieve App Compliance Information

Add an ACH account to an app for deposits.

Add App ACH Account

Get the ACH account information for an app.

Retrieve App ACH Account

Deposit funds into an app's wallet from its bank account.

Deposit Funds into App Wallet

Withdraw funds from an app's wallet into its bank account.

Withdraw Funds From App Wallet

Flows provide a simple yet customizable way to integrate payouts into your application.

Flows Overview

The Flow Object

Customize the look and feel of Flows to match the design of your site.

Flows Styles API

The Flows Styles API

Create a Flow to embed into your application.

Create a Flow

Retrieve a Flow

Payouts Overview

The easiest way to send a payout with Dots.

Send a Payout

Create a Payout

Payout Links Overview

Create Payout Link

Retrieve a Payout Link by ID

List all Payout Links created by your application.

List all Payout Links

Cancel a Payout Link that has been created by its ID.

Cancel a Payout Link

Create a Payout Request that can be approved on the Dots Dashboard.

Create a Payout Request

Everything you need to know about transfers on the Dots platform.

Transfers Overview

Create a Transfer to move money on the Dots platform.

Create a Transfer

Retrieve a Transfer

List all Transfers

Create multiple transfers in a single batch.

Create a Transfer Batch

Retrieve a Transfer Batch

List all transfer batches for your application.

List all Transfer Batches

Transactions Overview

Retrieve a Transaction

Get all transactions for your Dots account.

List all Transactions

Create and verify a user to your application.

Create a User

Retrieve a User

List all Users connected to your application.

List all Users

Add compliance information to a user via the API.

Add Compliance Information

Add Payout Methods

Create a Checkout Session link to accept a payment.

Create a Checkout Session

Retrieve a Checkout Session

List all Checkout Sessions created by your application.

List all Checkout Sessions

List All Disputes

Get Dispute by ID

Add Dispute Evidence

Submit Dispute

Create a Refund for an existing payment intent.

Create a Refund

List all refunds created by your application.

List all Refunds

Retrieve a Refund by ID

Create a Payment

Create a Payment Customer to save payment details for future use.

Create a Payment Customer

Retrieve a Payment Customer

List all Payment Customers for your application.

List all Payment Customers

Create a Payment Intent to accept a payment.

Create a Payment Intent

Retrieve a Payment Intent

List all Payment Intents created by your application.

List all Payment Intents

Confirm a Payment Intent to complete a payment.

Confirm a Payment Intent

Retrieve a Payment Methods

List payment methods for a payment customer.

List Payment Methods

Attach a payment methods to a payment customer for resuse.

Attach a Payment Methods

Detach a payment methods from a payment customer.

Detach a Payment Methods

Supported Countries

Webhooks

Dots API Documentation

Dots provides two enviromenments: Production and Sandbox.

Environments

Client Libraries

Dots Flows

Users

Create/Connect a User

Add 1099 Information

Transactions

Create a Transaction

A payout is a transfer of funds from a user's Dots wallet to an external account (such as a bank account). A payout can be initiated by a user through iFrames provided by Dots or though API calls made by the platform.

Payouts

Create an iFrame Payout

All requests to the /v2/payouts/* endpoints must include both the clientid and apikey as detailed in the Authentication document.

Create an API Payout

Create a Payout Link

Invoices Overview

Invoices

Creates a new invoice that has a link that the user can be redirected to complete a transaction

Name	Type	Description
`id`	string (uuid)	UUID id of the user
`first_name`	string	User’s first name
`last_name`	string	User’s last name
`email`	string	User’s email
`phone_number`	object	—
`phone_number.country_code`	string	The phone number country code e.g. `1`
`phone_number.phone_number`	string	The phone_number e.g. `1234567890`
`wallet`	object	—
`wallet.amount`	integer	Balance of the user’s wallet in cents
`wallet.withdrawable_balance`	integer	Withdrawable balance of the user’s wallet in cents
`wallet.credit_balance`	integer	Amount of credit for your app in the user’s wallet
`compliance`	object	—
`compliance.tax_id_collected`	boolean	`true` if tax id is collected and valid
`compliance.address_collected`	boolean	`true` if address is collected
`compliance.date_of_birth_collected`	boolean	`true` if date of birth is collected
`compliance.1099_collected`	boolean	`true` if 1099 information is collected
`compliance.w8_ben_collected`	boolean	`true` if W8-BEN information is collected
`compliance.flagged`	boolean	`true` if user is flagged for compliance reasons. Manual review will be required before they can be paid out
`compliance.id_verified`	boolean	`true` if the user has verified their government-issued ID
`metadata`	string/object/null	Additional data that can be added to the user

Overview

Guides

Core Resources

Payments

Other Information

Users Overview

The User Object

Attributes