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",
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "metadata": "<string>",
  "items": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": "<string>",
      "transfer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "created"
      },
      "error": "<string>",
      "request": {
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "platform": "paypal",
        "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "fund": true,
        "tax_exempt": true,
        "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "metadata": "<string>",
        "payout_fee_party": "user"
      }
    }
  ]
}

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

Query Parameters

​
include_request
boolean
default:false

Include the original request data for each item in the response. This can be useful for debugging or reconciliation.

Response

200 - application/json

OK

The payout batch with detailed results for each item. Basic payout batch response