Skip to main content
curl --request POST \
  --url https://api.dots.dev/api/v2/transfers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": -1000,
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "type": "refill",
  "amount": 123,
  "external_data": {
    "account_id": "<string>",
    "external_id": "<string>",
    "platform": "ach"
  },
  "transactions": [
    {
      "id": 123,
      "amount": 123,
      "created": "2023-11-07T05:31:56Z",
      "source_name": "<string>",
      "destination_name": "<string>",
      "type": "balance",
      "metadata": "<string>",
      "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transfer": {}
    }
  ],
  "payout_link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
amount
integer
required

The amount in cents to transfer. Negative amount transfers money from the app to the user.

​
user_id
string<uuid>
required

The user's id.

​
tax_exempt
boolean | null

Transfers marked as tax_exempt will not be counted towards the 1099 threshold.

​
idempotency_key
string<uuid> | null

UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.

​
metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Response

200 - application/json

OK

The transfer object.

​
id
string<uuid>
​
created
string<date-time>
​
user_id
string<uuid>
​
status
enum<string>
Available options:
created,
pending,
failed,
completed,
reversed,
canceled,
flagged
​
type
enum<string>

The type of this transfer.

  • refill - refill of an API App or Organization's Dots Wallet
  • payout - payout to a User
  • balance - balance transfer between Dots Wallets, such as from an API App to a User's Dots Wallet
  • payment - payment from a User to an API App
  • settlement - legacy, currently unused
  • payable - payable for Accounts Payable
Available options:
refill,
payout,
balance,
payment,
settlement,
payable
​
amount
number
​
external_data
object
​
transactions
object[]
​
payout_link_id
string<uuid>

ID of the payout-link that the transfer belongs to.

​
metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

⌘I