List batches

Every batch for the calling org — paginated, unlike the Sender/Beneficiary lists (a batch count can grow indefinitely). Returns bare batch rows only, no orders — use Get a batch for one batch’s full detail.

GET /api/v2/payouts

List batches

cURL

curl --request GET \
  --url https://api.mansa.xyz/api/v2/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

200

{
  "items": [
    {
      "id": "...",
      "status": "AWAITING_CONFIRMATION",
      "total_count": 1,
      "completed_count": 0,
      "failed_count": 0,
      "client_reference": null,
      "created_at": "2026-08-28T09:00:00.000Z",
      "updated_at": "2026-08-28T09:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 42
  }
}

Authorizations

x-api-key · string · header · required

API key for authentication

Authorization · string · header · required

ES256 JWT signed by the private key registered to the API key above. Claims: sub (=API key), uri, nbf, iat, exp, and bodyHash (HMAC-SHA512 of uri + rawBody + nbf using a shared secret, base64).

Query Parameters

status · enum<string>

AWAITING_CONFIRMATION: every order still DRAFT · IN_PROGRESS: at least one order confirmed, none terminal yet · COMPLETED: every order COMPLETED · PARTIALLY_COMPLETED: mix of completed and failed/cancelled · FAILED: every order failed or cancelled, none completed · CANCELLED_EXPIRED: rare, batch-level expiry.

Available options: AWAITING_CONFIRMATION, IN_PROGRESS, COMPLETED, PARTIALLY_COMPLETED, FAILED, CANCELLED_EXPIRED

page · integer · default: 1

Required range: x >= 1

limit · integer · default: 20

Sent to core-api as size.

Required range: 1 <= x <= 100

Response

200

application/json

List of batches

items · object[] · required

Show child attributes

meta · object · required

Show child attributes