Authentication Errors

Invoice Errors

Transaction Errors

User Information Errors

Service Errors

Dashboard

GitHub

client_id:api_key

Dots

API Reference

Get Started

Log in

Error Codes

Introduction

Power your Platform with Dots

How Dots Works

Concepts

Environments

Dots API Environments

API Authentication

Getting Started

Payout Links

Create a Flow

Flow Styles

Advanced Flow Features

White-Labeled Payouts

Users

Idempotency

Metadata

Supported Countries

Webhooks

IP Address Tracking

List all users connected to your application.

List all Users

Create a User

Retrieve a User

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

List all Transfers

Create a Transfer

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

Get an Organization Transfer

List all Flows

Retrieve a Flow

List all Payout Links

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.

Create a 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.

Send a Payout

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.

Create a Payout Request

Retrieve a Payout Request

List all Transactions

Retrieve a Transaction

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 Transfer Batches

Create a Transfer Batch

Retrieve a Transfer Batch

List all Payment Customers

Create a Payment Customer

Retrieve a Payment Customer

List all Checkout Sessions

Create a Checkout Session

Retrieve a Checkout Session

List all apps created by your organization

List all Apps

Create an App

Retrieve an app in your organization by its ID

Retrieve an App

Retrieve the compliance information for an app in your organization

Retrieve an App's Compliance Information

Add or update compliance information for an app in your organization

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.

Add App ACH Account

Deposit funds into App wallet by endpoint.

Deposit Funds into App Wallet

Withdraw funds from app wallet into app bank account.

Withdraw Funds From App Wallet

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.

Code	Description
`auth-email-already-exists`	The provided email address is already in use.
`auth-username-already-exists`	The provided username is already in use.
`invalid-input`	The input provided is invalid.
`invalid-ssn`	The provided Social Security Number (SSN) is invalid.
`invalid-username`	The username is invalid. Usernames may only contain letters, digits, and hyphens (`-`). They must not contain swear words or protected words.
`invalid-phone-number`	The phone number provided is invalid.
`invalid-email`	The email address provided is invalid.
`invalid-phone-number-voip`	VOIP phone numbers are not allowed.
`invalid-phone-number-landline`	Landline phone number not allowed.

Code	Description
`invalid-invoice-requested-information`	The value for requested information in the invoice is invalid.
`invalid-invoice-breakdown`	The breakdown of the invoice is invalid.
`invalid-invoice-item`	The invoice item is invalid.
`invalid-invoice-item-total`	The totals of the invoice items are incorrect.

Code	Description
`invalid-transaction`	The transaction is invalid.
`transaction-insufficient-funds`	There are insufficient funds in the wallet.

Code	Description
`user-info-missing`	The user has missing or invalid information.
`user-info-missing-cash-app`	The user is missing Cash App account information.
`user-info-missing-contact`	The user is missing contact information.
`user-info-missing-card`	The user is missing credit card information.
`app-info-missing`	The app has missing or invalid information.

Code	Description
`service-unavailable`	A service was unavailable.
`resource-busy`	The resource is unavailable because one or more previous requests are still being processed.

Overview

Guides

References

Error Codes

Authentication

Invoice

Transaction

User Information

Service

Authentication Errors

Invoice Errors

Transaction Errors

User Information Errors

Service Errors

Overview

Guides

References

Authentication

Invoice

Transaction

User Information

Service

​Authentication Errors

​Invoice Errors

​Transaction Errors

​User Information Errors

​Service Errors

Authentication Errors

Invoice Errors

Transaction Errors

User Information Errors

Service Errors