Transfer Batches
Create a Transfer Batch
Transfer Batches
Create a Transfer Batch
Create multiple transfers in a single batch.
POST
/
v2
/
transfer-batches
Authorization
Body
curl --request POST \
--url https://api.dots.dev/api/v2/transfer-batches \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"allow_debit": true,
"amount": 123,
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"tax_exempt": true,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"metadata": {}
}'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"allow_debit": true,
"amount": 123,
"error": "<string>",
"metadata": {},
"tax_exempt": true,
"transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"metadata": {},
"status": "pending"
}Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
idempotency_key
string
items
object[]
metadata
object
Response
200 - application/json
id
string
items
object[]
metadata
object
status
enum<string>
Available options:
pending, completed curl --request POST \
--url https://api.dots.dev/api/v2/transfer-batches \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"allow_debit": true,
"amount": 123,
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"tax_exempt": true,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"metadata": {}
}'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"allow_debit": true,
"amount": 123,
"error": "<string>",
"metadata": {},
"tax_exempt": true,
"transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"metadata": {},
"status": "pending"
}