transfer-batches
Retrieve a Transfer Batch
users
transfers
payout-links
payments
payment-intents
payment-customers
checkout-sessions
accounts-payable
- GETList all vendors
- POSTCreate a vendor
- GETGet vendor details
- DELDelete a vendor
- GETList all payment methods for a vendor
- POSTCreate a payment method for a vendor
- GETGet vendor payment method details
- DELDelete a vendor payment method
- GETList all payables
- POSTCreate a payable
- POSTCreate a payable from a file
- GETGet payable details
- PATCHUpdate a payable
- POSTUpload file to the payable
- DELDelete file from the payable
- POSTCancel a payable
- POSTSubmit a payable for approval
- POSTApprove a payable
- POSTReject a payable
- POSTPay a payable
- GETList all approval policies
- POSTCreate an approval policy
- DELDelete an approval policy
- PATCHUpdate priority of an approval policy
- GETList all approvers for api app
apps
payment-methods
organizations
transfer-batches
Retrieve a Transfer Batch
Get a transfer batch by id
curl --request GET \
--url https://api.dots.dev/api/v2/transfer-batches/{transfer_batch_id} \
--header 'Authorization: Basic <encoded-value>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "completed",
"metadata": {},
"items": [
{
"transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tax_exempt": true,
"allow_debit": true,
"metadata": {},
"error": "<string>"
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
Id of the transfer batch to fetch
Response
200 - application/json
OK
Available options:
completed
, pending
curl --request GET \
--url https://api.dots.dev/api/v2/transfer-batches/{transfer_batch_id} \
--header 'Authorization: Basic <encoded-value>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "completed",
"metadata": {},
"items": [
{
"transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tax_exempt": true,
"allow_debit": true,
"metadata": {},
"error": "<string>"
}
]
}