Metadata

API Reference

GitHub

client_id:api_key

Dots

Get Started

Log in

Introduction

Dots API V2 Documentation

Authentication

Dots provides two enviromenments: Production and Sandbox.

Environments

Error Codes

Your First Payout

Dots Drop-in Components

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

Retrieve a Flow

Payouts Overview

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.

Send a Payout

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

Create a Payout

Payout Links Overview

Create Payout Link

Get Payout Link by ID

List all Payout Links

Cancel a Payout Link

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.

Create a Payout Request

Transfers Overview

Create a Transfer

Retrieve a Transfer

List all Transfers

Create a Transfer Batch

Retrieve a Transfer Batch

List all Transfer Batches

Transactions Overview

Retrieve a Transaction

List all Transactions

Users Overview

Create a User

Retrieve a User

List all users connected to your application.

List all Users

Add Compliance Information

Add Payout Methods

Create a Checkout Session

Retrieve a Checkout Session

List all Checkout Sessions

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

Create a Payment Customer

Retrieve a Payment Customer

List all Payment Customers

Create a Payment Intent

Retrieve a Payment Intent

Supported Countries

Webhooks

Dots API Documentation

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

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

Cancel a Payout Link by ID

Create Payout

Send Payout

Get Transactions

Get Transaction By ID

Create/Connect a new User

Send a verification token to the user

Verify a user with the token sent to them

Retrieve and filter connected app user IDs

Get the user by their id

Add KYC or KYB information for User

Retrieve limited information about a user given a verification ID

Generate a link to refill the user's wallet

Generate a link to payout the user's wallet

Programatically add a payout method for a user

Create a payout

Create a payout link

Send a payout

Create a direct payout. It must be enabled for your account

Create transaction

Create transaction (unverified user)

Creates multiple transactions asynchronously. Errors will be delivered by email.

Overview

Guides

Core Resources

Payments

Other Information

Metadata