Skip to main content
GET
/
v2
/
payout-batches
/
{payout_batch_id}
Retrieve a Payout Batch
curl --request GET \
  --url https://api.dots.dev/api/v2/payout-batches/{payout_batch_id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "status": "created",
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<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.

Path Parameters

​
payout_batch_id
string<uuid>
required

Id of the payout batch to fetch

Response

200 - application/json

OK

Basic payout batch response

​
id
string<uuid>
required

Unique identifier for the payout batch.

​
created
string<date-time>
required

Timestamp when the batch was created.

​
status
enum<string>
required

Current status of the batch processing.

Available options:
created,
processing,
paying_out,
completed
​
idempotency_key
string<uuid>

The idempotency key provided when creating the batch.

​
metadata

The metadata attached to the batch.