> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.paylias.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Settlement Batch Details > Fetch merkle artefacts and net positions for a settlement batch ## OpenAPI ````yaml get /api/v1/csp/settlements/{batch_id} openapi: 3.1.0 info: title: Paylias API description: >- Paylias is a network that enables developers to orchestrate money movement between different financial institutions with ease and speed. The Paylias API makes it simple for financial platforms to issue virtual addresses, manage connections and exchange value by sending and receiving money. Our API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes. version: 0.1.0 contact: {} servers: - url: https://sandbox.api.paylias.xyz/gateway security: [] tags: - name: API Authentication description: >- For server-to-server communication, Paylias supports authentication through JWT tokens as well as API keys. All APIs that are that deal with the `Organization` resource are authenticated using JWT tokens, while the rest of the system uses API Keys to authenticate To use a JWT token, set the Authorization header to `Bearer`. To use an API key, set a header called `X-PAYLIAS-API-KEY` and use the API key as the value. ## JWT token When making requests to Paylias from a browser, you can use JSON Web Tokens (JWT). This requires the credentials of a user that has admin access. The validity of JWT tokens issued by Paylias is 7 days. ## API key Longer lasting access tokens can be generated with fine grained permissions using the Create API key endpoint. These access tokens can be rotated, revoked and updated through the browser as well. API Keys are linked to a Namespace to allow finer access controls when dealing with API requests using long lived tokens. While account admins can take actions on API keys from the dashboard, the `X-Partner-ID` header must be set to the id of the Namespace for which the API key was originally issued against. - name: Organizations description: >- In the Paylias network, an `Organization` represents a legal entity, specifically a financial institution. It stands at the top of the system's hierarchy, overseeing sub-entities like `api keys`, `webhooks`, and `partners`. Given its financial nature, the Paylias network has certain verification processes to fulfill. When users join the Paylias dashboard, they initially receive an account in a sandboxed environment. This phase allows for familiarization without impacting the main system. Full access is granted once a member of the Paylias team validates and completes all necessary formalities for the user. For efficient management, users can either use the dashboard or APIs, with the latter requiring a valid JWT Token for secure interactions. - name: Namespace description: >- A `namespace` is a logical collection of payment addresses that are issued by an `organization`. Payment addresses issued inside a `namespace` will share a common `domain`. The domain helps identify organizations, country of issuance and other specifics around the brand, rewards and configurations. - name: Accounts - name: Validation - name: API Keys description: >- Longer lasting access tokens can be generated with fine grained permissions using the Create API key endpoint. These access tokens can be rotated, revoked and updated through the browser as well. API Keys are linked to a Namespace to allow finer access controls when dealing with API requests using long lived tokens. While account admins can take actions on API keys from the dashboard, the `X-Partner-ID` header must be set to the id of the Namespace for which the API key was originally issued against. - name: Webhooks description: >- Webhooks allow applications to communicate in real-time. When an event occurs, a webhook will deliver the event data to the application determined by the target endpoint. A webhook can be setup to be notified of all event types or specific ones. This allows your application to react to events, which is more efficient than polling an API to determine if an event has occurred. In the Paylias network, webhooks are used to communicate events related to Links and Payments. Similar to API Keys, Webhooks are created against a Namespace and thus require the `X-Partner-ID` header to be set in all requests ## Event types Here are the event types that we capture and send. This may not be a comprehensive list as we are continuing to add events to our system. | **Event Identifier** | **Description** | | --- | --- | | `link.create.resp` | A link request has been processed | | `link.propose.req` | A link request has been proposed | | `link_established` | A link has been established | | `link_update_resp` | A link has been updated | - name: Customers - name: Payments - name: Submissions - name: Admissions - name: Admission Tasks - name: Transactions - name: Settlements description: Settlement batches, partner merkle artefacts, and settlement net positions - name: Exceptions paths: /api/v1/csp/settlements/{batch_id}: get: tags: - Settlements summary: Settlement Batch Details description: Fetch merkle artefacts and net positions for a settlement batch operationId: getSettlementBatchDetails parameters: - $ref: '#/components/parameters/OrganizationIdHeader' - $ref: '#/components/parameters/PartnerIdHeader' - $ref: '#/components/parameters/BatchIdParam' responses: '200': $ref: '#/components/responses/BatchDetailsResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' security: - bearerAuth: [] - apiKey: [] components: parameters: OrganizationIdHeader: name: x-org-id in: header required: true schema: type: string default: '' description: The Organization ID header used for authorization PartnerIdHeader: name: x-partner-id in: header required: true schema: type: string default: '' description: The Partner ID header used for authorization BatchIdParam: name: batch_id in: path required: true schema: type: string example: batch_123456789 description: The unique identifier for the settlement batch responses: BatchDetailsResponse: description: Response containing detailed settlement batch artefacts headers: Content-Length: $ref: '#/components/headers/ContentLengthHeader' Date: $ref: '#/components/headers/DateHeader' X-Csp-Version: $ref: '#/components/headers/CspVersionHeader' X-Partner-Id: $ref: '#/components/headers/PartnerIdHeader' X-Org-Id: $ref: '#/components/headers/OrgIdHeader' content: application/json: schema: allOf: - $ref: '#/components/schemas/StandardResponse' - type: object properties: data: $ref: '#/components/schemas/BatchDetails' examples: success: value: 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' BadRequest: description: Bad request headers: Content-Length: $ref: '#/components/headers/ContentLengthHeader' Date: $ref: '#/components/headers/DateHeader' X-Csp-Version: $ref: '#/components/headers/CspVersionHeader' content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: code: example: error.bad_request message: example: Invalid request parameters Unauthorized: description: Unauthorized headers: Content-Length: $ref: '#/components/headers/ContentLengthHeader' Date: $ref: '#/components/headers/DateHeader' X-Csp-Version: $ref: '#/components/headers/CspVersionHeader' content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: code: example: error.unauthorized message: example: Authentication required NotFound: description: Resource not found headers: Content-Length: $ref: '#/components/headers/ContentLengthHeader' Date: $ref: '#/components/headers/DateHeader' X-Csp-Version: $ref: '#/components/headers/CspVersionHeader' content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: code: example: error.not_found message: example: Requested resource not found headers: ContentLengthHeader: schema: type: string example: '256' DateHeader: schema: type: string example: Sat, 12 Aug 2023 08:55:04 GMT CspVersionHeader: schema: type: string example: gateway-csp/v1.0.0 PartnerIdHeader: schema: type: string example: part_123456789 OrgIdHeader: schema: type: string example: org_123456789 schemas: StandardResponse: type: object description: Standard response structure for successful operations properties: ok: type: boolean example: true description: Indicates if the operation was successful data: type: object description: Contains the response data BatchDetails: type: object description: Comprehensive settlement batch details for the partner properties: summary: $ref: '#/components/schemas/BatchSummary' merkle_root: allOf: - $ref: '#/components/schemas/BatchMerkleRoot' nullable: true merkle_leaf: allOf: - $ref: '#/components/schemas/BatchMerkleLeaf' nullable: true positions: type: array items: $ref: '#/components/schemas/BatchNetPosition' description: Net positions for the partner ErrorResponse: type: object description: Standard error response structure properties: code: type: string description: Error code identifying the type of error message: type: string description: Human-readable error message BatchSummary: type: object description: Settlement batch summary information properties: token: type: string example: batch_123456789 description: Batch identifier token cutoff_time: type: integer format: int64 example: 1706630400 description: Cutoff timestamp in seconds started_on: type: integer format: int64 example: 1706626800 description: Batch start timestamp in seconds completed_on: type: integer format: int64 example: 1706634000 nullable: true description: Batch completion timestamp in seconds status: type: string description: Batch processing status enum: - PROCESSING - COMPLETED - FAILED txn_count: type: integer format: int64 example: 42 description: Number of settled transactions visible to the partner BatchMerkleRoot: type: object description: Merkle root artefact for the settlement batch properties: root_hash: type: string format: byte description: Merkle root hash encoded as base64 version: type: string example: v1 description: Merkle tree schema version leaves_count: type: integer format: int32 example: 128 description: Number of leaves included in the tree created_at: type: string format: date-time example: '2024-01-30T12:30:00Z' description: Timestamp when the merkle root was generated BatchMerkleLeaf: type: object description: Merkle leaf artefact for the authenticated partner properties: partner_id: type: string example: part_123456789 description: Canonical partner identifier encoded in the leaf kind: type: string description: Leaf classification based on the partner net position enum: - creditor - debtor amount: type: string example: '1250000' description: Leaf amount in minor units leaf_hash: type: string format: byte description: Leaf hash encoded as base64 BatchNetPosition: type: object description: Net position for the partner against a counterparty within the batch properties: counterparty_id: type: string example: part_987654321 description: Counterparty partner identifier currency: type: string example: PKR description: ISO currency code for the position amount position_type: type: string description: Whether the partner is net debtor or creditor enum: - Debit - Credit net_amount: type: string example: '450000' description: Net position amount in minor units securitySchemes: bearerAuth: type: http scheme: bearer apiKey: type: apiKey name: X-PAYLIAS-API-KEY in: header ````