- Transfers
- Create a Transfer
Transfers
Create a Transfer
Create a transfer.
POST
/api/v2/transfers
client_id*
api_key*
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/transfers \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"amount": integer,
"user_id": "string"
}'Body
amountRequired
integer
The amount in cents to transfer. Negative amount transfers money from the app to the user.
user_idRequired
string
The user's id.
tax_exempt
boolean | null
Transfers marked as tax_exempt will not be counted towards the 1099 threshold.
idempotency_key
string | null
UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.
metadata
string | object | null
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
id
string
created
string
user_id
string
status
string
Available options:
created, pending, failed, completed, flagged type
string
Available options:
refill, payout, balance amount
number
external_data
object
transactions
array
metadata
string | object | null
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.
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/transfers \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"amount": integer,
"user_id": "string"
}'