Retrieve a Payout Batch with detailed results

Get a payout batch by its id. Returns detailed results for each item in the batch, including transfer information for successful payouts and error messages for failed ones.

GET /v2/payout-batches/{payout_batch_id}/results

Retrieve a Payout Batch with detailed results

cURL

curl --request GET \
  --url https://api.dots.dev/api/v2/payout-batches/{payout_batch_id}/results \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "items": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": "<string>",
      "transfer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "error_code": "<string>",
      "error_message": "<string>",
      "request": {
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "fund": true,
        "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tax_exempt": true,
        "metadata": "<string>"
      }
    }
  ],
  "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

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.

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

items · payout-batch-results-item · object[] · required

Results for each item in the batch.

Show child attributes

idempotency_key · string<uuid>

The idempotency key provided when creating the batch.

metadata · string object

The metadata attached to the batch.