Get a batch

GET

batches

{id}

Get a batch

curl --request GET \
  --url https://sandbox-api.infinityapp.in/v1/batches/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "batch_fcb4cuwtd6fcbmwr",
  "number": "PB-2026-21",
  "name": "October invoices",
  "description": "October invoices",
  "status": "processing",
  "wallet_id": "wallet_7t4m9k2qx8d3hn5r",
  "debit_currency": "usd",
  "total_debit": "1136.70",
  "total_fee": "20.00",
  "payee_count": 2,
  "payout_summary": {
    "total": 2,
    "pending": 0,
    "processing": 1,
    "paid": 0,
    "failed": 0,
    "returned": 0,
    "awaiting_payee": 1,
    "awaiting_funds": 0,
    "canceled": 0,
    "expired": 0
  },
  "payouts": [
    {
      "id": "payout_4kz9xq7m2w8dn3ra",
      "batch_id": "batch_fcb4cuwtd6fcbmwr",
      "wallet_id": "wallet_7t4m9k2qx8d3hn5r",
      "payee_id": "payee_c8pnahcrxqzd3z8d",
      "amount": "500.00",
      "currency": "eur",
      "debit_amount": "568.35",
      "debit_currency": "usd",
      "fee": "10.00",
      "fee_bearer": "account",
      "rate": "0.8955",
      "payee_amount": "500.00",
      "payee_currency": "eur",
      "status": "pending",
      "failure_code": null,
      "failure_message": null,
      "hold_expires_at": null,
      "description": "October invoice",
      "reference": "inv-1042",
      "metadata": {
        "invoice": "inv-1042"
      },
      "created_at": "2026-10-26T10:05:00Z",
      "updated_at": "2026-10-26T10:05:00Z"
    }
  ],
  "reference": "run-2026-10",
  "metadata": {
    "invoice": "inv-1042"
  },
  "created_at": "2026-10-26T10:05:00Z",
  "updated_at": "2026-10-26T10:05:00Z"
}

{
  "error": {
    "type": "authentication_error",
    "code": "wrong_environment",
    "message": "This is a live key. Use it on api.infinityapp.in.",
    "param": null,
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

Authorizations

Authorization

string

header

required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Path Parameters

string

required

Example:

"batch_fcb4cuwtd6fcbmwr"

Response

The batch as it is now.

string

required

Example:

"batch_fcb4cuwtd6fcbmwr"

number

string

required

Your account's running count, as on the dashboard.

Example:

"PB-2026-21"

name

string

required

The name sent on creation, or API batch plus the UTC date and time.

Example:

"October invoices"

description

string | null

required

Example:

"October invoices"

status

enum<string>

required

Worked out from the batch's payouts, so it can move more than once.

Available options:

pending,

processing,

completed,

partially_completed,

failed,

awaiting_payees,

awaiting_funds,

canceled

Example:

"processing"

wallet_id

string

required

The wallet that paid.

Example:

"wallet_7t4m9k2qx8d3hn5r"

debit_currency

string

required

The currency of the paying wallet.

Example:

"usd"

total_debit

string

required

The sum of its payouts' debit_amount.

Example:

"1136.70"

total_fee

string | null

required

Example:

"20.00"

payee_count

integer

required

Example:

2

payout_summary

object

required

How many of the batch's payouts are in each status.

Show child attributes

payouts

object[]

required

The batch's payouts in request order.

Show child attributes

reference

string | null

required

Example:

"run-2026-10"

metadata

object

required

Up to 20 key-value pairs of your own. Keys up to 40 characters, values up to 500, strings only.

Show child attributes

Example:

{ "invoice": "inv-1042" }

created_at

string<date-time>

required

Example:

"2026-10-26T10:05:00Z"

updated_at

string<date-time>

required

Example:

"2026-10-26T10:05:00Z"

Get a batch

curl --request GET \
  --url https://sandbox-api.infinityapp.in/v1/batches/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "batch_fcb4cuwtd6fcbmwr",
  "number": "PB-2026-21",
  "name": "October invoices",
  "description": "October invoices",
  "status": "processing",
  "wallet_id": "wallet_7t4m9k2qx8d3hn5r",
  "debit_currency": "usd",
  "total_debit": "1136.70",
  "total_fee": "20.00",
  "payee_count": 2,
  "payout_summary": {
    "total": 2,
    "pending": 0,
    "processing": 1,
    "paid": 0,
    "failed": 0,
    "returned": 0,
    "awaiting_payee": 1,
    "awaiting_funds": 0,
    "canceled": 0,
    "expired": 0
  },
  "payouts": [
    {
      "id": "payout_4kz9xq7m2w8dn3ra",
      "batch_id": "batch_fcb4cuwtd6fcbmwr",
      "wallet_id": "wallet_7t4m9k2qx8d3hn5r",
      "payee_id": "payee_c8pnahcrxqzd3z8d",
      "amount": "500.00",
      "currency": "eur",
      "debit_amount": "568.35",
      "debit_currency": "usd",
      "fee": "10.00",
      "fee_bearer": "account",
      "rate": "0.8955",
      "payee_amount": "500.00",
      "payee_currency": "eur",
      "status": "pending",
      "failure_code": null,
      "failure_message": null,
      "hold_expires_at": null,
      "description": "October invoice",
      "reference": "inv-1042",
      "metadata": {
        "invoice": "inv-1042"
      },
      "created_at": "2026-10-26T10:05:00Z",
      "updated_at": "2026-10-26T10:05:00Z"
    }
  ],
  "reference": "run-2026-10",
  "metadata": {
    "invoice": "inv-1042"
  },
  "created_at": "2026-10-26T10:05:00Z",
  "updated_at": "2026-10-26T10:05:00Z"
}

{
  "error": {
    "type": "authentication_error",
    "code": "wrong_environment",
    "message": "This is a live key. Use it on api.infinityapp.in.",
    "param": null,
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_payout_request",
    "message": "amount has more than 2 decimals for eur.",
    "param": "amount",
    "request_id": "req_4f4b2bjc4mamxuxm",
    "timestamp": "2026-10-29T10:00:00Z"
  }
}

Account

Wallets

Funding addresses

Deposits

Currencies

Exchange rates

Payees

Payee addresses

Bank requirements

Quotes

Payouts

Batches

Webhook endpoints

Events

API Reference

Authorizations

Path Parameters

Response