Retrieve a Refund

api key

refund

client_id:api_key

Dots

Dashboard

GitHub

API Reference

Get Started

Log in

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

Error Codes

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 vendors

Create a vendor in your app for accounts payable

Create a vendor

Get vendor details

Delete a vendor

List all payment methods for a vendor

Create a payment method for a vendor to pay to

Create a payment method for a vendor

Get vendor payment method details

Delete a vendor payment method

List all payables

Create a payable in your app for accounts payable. The minimum required details to create a payable is the payable number. Remaining fields can be added later by updating the payable before submission.

Create a payable

Create a payable from a file. The contents of the file will be processed and the payable will be created.

Create a payable from a file

Get payable details

Update a payable that has not been submitted for approval. To upload/delete the file, use the `/file` endpoint.

Update a payable

Upload a file to be attached to the payable

Upload file to the payable

Delete file from the payable

Cancel a payable that has not been submitted for approval

Cancel a payable

Submit a payable for approval

Approve a payable

Reject a payable

Pay a payable

List all approval policies

Create an approval policy that will apply approval steps to payables in your app. It will only apply to policies that match the `approval_conditions` and are in state `submitted_for_approval`. Policies that already have approval steps will not be overwritten.

Create an approval policy

Delete an approval policy

Update the priority of an approval policy by its ID

Update priority of an approval policy

List all approvers for api app

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.

Refresh compliance flow

Update an application's payout and refill settings.

Update an application's settings

Get the payment methods for a payment customer

List all Payment Methods for a Payment Customer

Retrieve a Payment Method

Attach a payment method to a payment customer for future usage.

Attach a Payment Method to a Payment Customer

Detach a payment method from a payment customer

Detach Payment Method from a Payment Customer

List all Disputes

Retrieve a Dispute

Add Evidence to a Dispute

Submit a Dispute

List all Refunds

Create a Refund

Get details about the authenticated organization, including its current balance.

users

transfers

flows

payout-links

payouts

payments

payout-requests

transactions

payment-intents

transfer-batches

payment-customers

checkout-sessions

accounts-payable

apps

payment-methods

disputes

refunds

organizations

Retrieve a Refund

Authorizations

Path Parameters

Response