Skip to main content
GET
/
api
/
v1
/
csp
/
settlements
/
{batch_id}
Settlement Batch Details
curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/settlements/{batch_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-org-id: <x-org-id>' \
  --header 'x-partner-id: <x-partner-id>'
{
  "ok": true,
  "data": {
    "summary": {
      "token": "batch_123456789",
      "cutoff_time": 1706630400,
      "started_on": 1706626800,
      "completed_on": 1706634000,
      "status": "COMPLETED",
      "txn_count": 42
    },
    "merkle_root": {
      "root_hash": "R29sYW5nTWVya2xlUm9vdA==",
      "version": "v1",
      "leaves_count": 128,
      "created_at": "2024-01-30T12:30:00Z"
    },
    "merkle_leaf": {
      "partner_id": "part_123456789",
      "kind": "creditor",
      "amount": "1250000",
      "leaf_hash": "TGVhZkhhc2hCYXNlNjQ="
    },
    "positions": [
      {
        "counterparty_id": "part_987654321",
        "currency": "PKR",
        "position_type": "Credit",
        "net_amount": "450000"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-org-id
string
default:""
required

The Organization ID header used for authorization

x-partner-id
string
default:""
required

The Partner ID header used for authorization

Path Parameters

batch_id
string
required

The unique identifier for the settlement batch

Example:

"batch_123456789"

Response

Response containing detailed settlement batch artefacts

Standard response structure for successful operations

ok
boolean

Indicates if the operation was successful

Example:

true

data
object

Contains the response data Comprehensive settlement batch details for the partner

I