client_id:api_key

Dots

API Reference

GitHub

Get Started

Log in

Retrieve a Transfer Batch

api key

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

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

Get or refresh an app's KYB compliance flow

Refresh App Compliance Flow

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

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

Supported Countries

Webhooks

List all users connected to your application.

Delete a User

Update a user

Submit Compliance Information

Send a Verification Token

Verify a User

List 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 a Payout Method

Add User Address

Get a Transfer

List all transfers to and from an Organization's wallet.

List all Organization Transfers

Create a transfer for the organization's wallet to an api app.

Create an Organization Transfer

List all Flows

Create a Payout Link

Retrieve a Payout Link

Delete a Payout Link

Redeliver a payout link. Payout links will be delivered up to 5 times.

Redeliver Payout Link

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

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.

Creates a transaction from a user or a payment customer to the app. User the `/users/{user_id}/payout-methods` route to get a user's stored payment methods.

Create a Payment

List all Payout Requests

Submit a payout request from a person when you know their phone number or user id. Once the payout request is approved, they will be sent a Payout Link to onboard and recieve funds.

Retrieve a Payout Request

List all Payment Intents

Create a Payment Intent

Retrieve a Payment Intent

Confirm a payment intent that has not been confirmed yet.

Confirm a Payment Intent

List all Payment Customers

Create a Payment Customer

Retrieve a Payment Customer

List all Checkout Sessions

Create a Checkout Session

Retrieve a Checkout Session

Retrieve an App's Compliance Information

Update an App's Compliance Information

Get App ACH Account

Add an ACH account to an app. The account's owner must match the compliance information submitted.

Deposit funds into App wallet by endpoint.

Withdraw funds from app wallet into app bank account.

Refresh the app's KYB compliance flow. Returns a URL that can be shared or embedded to allow the app's owners to submit mandatory onboarding information about their business.
The flow URL will expire after 72 hours. Refreshing the flow will also expire the old URL.

Overview

Guides

Core Resources

Other Information

Retrieve a Transfer Batch

Authorizations

Path Parameters

Response