Create a Transfer Batch

Create a transfer batch

POST /v2/transfer-batches

Create a Transfer Batch

cURL

curl --request POST \
  --url https://api.dots.dev/api/v2/transfer-batches \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "amount": 123,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tax_exempt": true,
      "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {}
    }
  ],
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {}
}
'

import requests

url = "https://api.dots.dev/api/v2/transfer-batches"

payload = {
    "items": [
        {
            "amount": 123,
            "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tax_exempt": True,
            "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "metadata": {}
        }
    ],
    "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        amount: 123,
        user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        tax_exempt: true,
        idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        metadata: {}
      }
    ],
    idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    metadata: {}
  })
};

fetch('https://api.dots.dev/api/v2/transfer-batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dots.dev/api/v2/transfer-batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'amount' => 123,
                'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'tax_exempt' => true,
                'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'metadata' => [
                                
                ]
        ]
    ],
    'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dots.dev/api/v2/transfer-batches"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tax_exempt\": true,\n      \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"metadata\": {}\n    }\n  ],\n  \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dots.dev/api/v2/transfer-batches")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tax_exempt\": true,\n      \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"metadata\": {}\n    }\n  ],\n  \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dots.dev/api/v2/transfer-batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tax_exempt\": true,\n      \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"metadata\": {}\n    }\n  ],\n  \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "items": [
    {
      "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tax_exempt": true,
      "metadata": {},
      "error": "<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/jsonapplication/xml

items · object[]

Show child attributes

idempotency_key · string<uuid>

metadata · object

Response

200 - application/json

OK

id · string<uuid>

status · enum<string>

Available options: pending, completed

metadata · object

items · transfer-batch-item · object[]

Show child attributes