Log in
Get Started
Get Started

Documentation

API Reference

Dashboard
GitHub

users

GET
List all Users
POST
Create a User
GET
Retrieve a User
DEL
Delete a User
PATCH
Update a user
PUT
Submit Compliance Information
POST
Send a Verification Token
POST
Verify a User
GET
List Payout Methods
PUT
Add a Payout Method
PUT
Add User Address

transfers

GET
List all Transfers
POST
Create a Transfer
GET
Get a Transfer
GET
List all Organization Transfers
POST
Create an Organization Transfer
GET
Get an Organization Transfer

flows

GET
List all Flows
POST
Create a Flow
GET
Retrieve a Flow

payout-links

GET
List all Payout Links
POST
Create a Payout Link
GET
Retrieve a Payout Link
DEL
Delete a Payout Link
POST
Redeliver Payout Link

payouts

POST
Create a Payout
POST
Send a Payout

payout-batches

GET
List all Payout Batches
POST
Create a Payout Batch
GET
Retrieve a Payout Batch

payments

POST
Create a Payment

payout-requests

GET
List all Payout Requests
POST
Create a Payout Request
GET
Retrieve a Payout Request

transactions

GET
List all Transactions
GET
Retrieve a Transaction

payment-intents

GET
List all Payment Intents
POST
Create a Payment Intent
GET
Retrieve a Payment Intent
POST
Confirm a Payment Intent

transfer-batches

GET
List all Transfer Batches
POST
Create a Transfer Batch
GET
Retrieve a Transfer Batch

payment-customers

GET
List all Payment Customers
POST
Create a Payment Customer
GET
Retrieve a Payment Customer

checkout-sessions

GET
List all Checkout Sessions
POST
Create a Checkout Session
GET
Retrieve a Checkout Session

accounts-payable

GET
List all vendors
POST
Create a vendor
GET
Get vendor details
DEL
Delete a vendor
GET
List all payment methods for a vendor
POST
Create a payment method for a vendor
GET
Get vendor payment method details
DEL
Delete a vendor payment method
GET
List all payables
POST
Create a payable
POST
Create a payable from a file
GET
Get payable details
PATCH
Update a payable
POST
Upload file to the payable
DEL
Delete file from the payable
POST
Cancel a payable
POST
Submit a payable for approval
POST
Approve a payable
POST
Reject a payable
POST
Pay a payable
GET
List all approval policies
POST
Create an approval policy
DEL
Delete an approval policy
PATCH
Update priority of an approval policy
GET
List all approvers for api app

apps

GET
List all Apps
POST
Create an App
GET
Retrieve an App
GET
Retrieve an App's Compliance Information
PUT
Update an App's Compliance Information
GET
Get App ACH Account
PUT
Add App ACH Account
POST
Deposit Funds into App Wallet
POST
Withdraw Funds From App Wallet
POST
Refresh compliance flow
POST
Update an application's settings

payment-methods

GET
List all Payment Methods for a Payment Customer
GET
Retrieve a Payment Method
POST
Attach a Payment Method to a Payment Customer
POST
Detach Payment Method from a Payment Customer

disputes

GET
List all Disputes
GET
Retrieve a Dispute
POST
Add Evidence to a Dispute
POST
Submit a Dispute

refunds

GET
List all Refunds
POST
Create a Refund
GET
Retrieve a Refund

organizations

GET
Retrieve Organization Details
PUT
Copy compliance information between applications
PUT
Copy organization compliance information to an application

payouts

Send 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.

Was this page helpful?

Suggest edits Raise issue

Create a Payout List all Payout Batches

github twitter linkedin

Powered by

Assistant

Responses are generated using AI and may contain mistakes.