Retrieve a Payout Batch with detailed results

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

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

GET

payout-batches

{payout_batch_id}

results

Retrieve a Payout Batch with detailed results

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

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

The payout batch with detailed results for each item.

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

items.user_id

string<uuid>

required

ID of the user for this payout.

items.idempotency_key

string<uuid>

required

The idempotency key for this specific item.

items.metadata

The metadata attached to this item.

items.transfer

object

Transfer information if the payout was successful.

Show child attributes

items.transfer.id

string<uuid>

required

ID of the transfer created for this batch item.

items.transfer.status

enum<string>

required

Current status of the transfer.

Available options:

created,

pending,

failed,

completed,

reversed,

canceled,

flagged

items.error_code

string

Error code if the payout failed.

items.error_message

string

Error message if the payout failed.

items.request

payout-batch-request-item · object

Original request for this item (only included when include_request=true). Base schema for creating a payout

Show child attributes

items.request.user_id

string<uuid>

required

ID of the user who you are creating the payout for.

items.request.amount

integer

required

Amount in cents to payout the user.

items.request.platform

enum<string>

required

Platform that you are paying out the user through.

Available options:

paypal,

venmo,

ach,

bank_transfer,

cash_app,

default

items.request.fund

boolean

required

Creates a transfer for the amount to the user before creating the payout. The funds are returned to the App Wallet if the payout does not succeed. Please ensure that you are handling transfer failure webhooks when using this option.

items.request.idempotency_key

string<uuid>

required

UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.

items.request.account_id

string<uuid>

The bank account ID you are paying to. Required for ach and intl_bank.

items.request.tax_exempt

boolean

Payouts marked as tax_exempt will not be counted towards the 1099 threshold. Can be true only if fund is true.

items.request.metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

items.request.payout_fee_party

enum<string>

Overrides the setting for which party will pay fees on this payout. This takes precedence over the default for your application.

Available options:

user,

platform

idempotency_key

string<uuid>

The idempotency key provided when creating the batch.

metadata

The metadata attached to the batch.

Retrieve a Payout Batch Create a Payment

⌘I

users

transfers

flows

payout-links

payouts

payout-batches

payments

payout-requests

transactions

payment-intents

transfer-batches

payment-customers

checkout-sessions

accounts-payable

apps

payment-methods

disputes

refunds

organizations

Retrieve a Payout Batch with detailed results

Authorizations

Path Parameters

Query Parameters

Response