Transfer Batches
Retrieve a Transfer Batch
Transfer Batches
Retrieve a Transfer Batch
Retrieve a Transfer Batch by ID
GET
/
v2
/
transfer-batches
/
{transfer_batch_id}
Authorization
Path
curl --request GET \
--url https://api.dots.dev/api/v2/transfer-batches/{transfer_batch_id} \
--header 'Authorization: <authorization>'{
"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": "completed"
}Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
transfer_batch_id
string
requiredId of the transfer batch to fetch
Response
200 - application/json
id
string
items
object[]
metadata
object
status
enum<string>
Available options:
completed, pending curl --request GET \
--url https://api.dots.dev/api/v2/transfer-batches/{transfer_batch_id} \
--header 'Authorization: <authorization>'{
"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": "completed"
}