Create a Flow

dotsdev

API Reference

GitHub

client_id:api_key

Dots

Get Started

Log in

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 in your organization by its ID

Retrieve an App

List all apps created by your organization

List all Apps

Add or update compliance information for an app in your organization

Add App Compliance Information

Retrieve the compliance information for an app in your organization

Retrieve App Compliance Information

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.

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

Everything you need to know about users on the Dots Platform

Users Overview

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

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

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

Create an Invoice

Retrieve an Invoice

Working with Unverified Users

API Introduction

List all users connected to your application.

Get Users

Create User

Get User by ID

Delete User by ID

Send Verification Token

Verify User

Get Payout Methods

Add a payout method to the user. Payout method can be one of `paypal`, `venmo`, `ach`, or `cash_app`. Each method has different required parameters.

Add Payout Method

Get Transfers

Create Transfer

Get Transfer by ID

Get Flows

Create Flow

Get Flow by ID

Get Payout Links

Get Payout Link by ID

Cancel a Payout Link by ID

Create a payout for an existing user that has a payout method saved to their account.

Create Payout

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.

Name	Type	Required	Description
`steps`	list[string]	✔️	List of steps. Step is one of [compliance, manage-payments, manage-payouts, payout]
`user_id`	string (uuid)		User to pre-authenticte the flow for

Overview

Guides

Core Resources

Payments

Other Information

Create a Flow

Method

Request Example

Parameters

Styling

Overview

Guides

Core Resources

Payments

Other Information

​Method

​Request Example

​Parameters

​Styling

Method

Request Example

Parameters

Styling