---
title: "Retrieve Settlement"
method: POST
path: "/pasettlements/v1_2/settlements/get"
tags: ["Settlement"]
---

# Retrieve Settlement

`POST /pasettlements/v1_2/settlements/get`

You can fetch the list of settlements created within a specific time period range using this API.

## Headers

- `BD-Traceid` string, required
- `BD-Timestamp` string, required
- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `mercid` string — Unique identifier as defined by BillDesk for each merchant
  - `from_date` string — From date in YYYYMMDD format – date from when the merchant wants to fetch the settlement details If the merchant wants to fetch settlement details for only one day, the merchant should specify the same date in ‘from_date’ and ‘to_date’ This attribute is Mandatory when the pv_number is not provided in the request
  - `to_date` string — To date in YYYYMMDD format – date up to when the merchant wants to fetch settlement details The maximum date range supported will be 7 days.
  - `pv_number` string — pv_number provided by BillDesk for the settlement This attribute is Mandatory if the ‘from_date’ is not provided.

## Response `200`

OK

- object[]
  - `objectid` 'transaction' | 'authentication' | 'mandate' | 'invoice' | 'cardaccount' | 'validatevpa' | 'dispute' | 'settlement' | 'altid' | 'mandate_token' | 'accountvalidation' — String representing the object's type. Objects of the same type share the same value.
  - `pv_number` string — Unique pv_number provided by BillDesk for the settlement
  - `mercid` string — Unique identifier as defined by BillDesk for each merchant
  - `payout_mercid` string — Unique identifier for the merchant assigned in respect of the payout
  - `pv_file` string — Name of the file, referencing the PV
  - `pv_file_date` string — Date of generation of the PV file
  - `currency` string — ISO currency of the transaction amount, for INR this value will be 356
  - `amount_details` object
    - `settlement` string — positive, amount in respect of transactions to be settled to the merchant
    - `refund` string — negative, amount deducted in respect of refunds that are initiated
    - `chargeback` string — negative, amount deducted in respect of chargebacks
    - `refund_reversal` string — positive, amount in respect of refunds that could not be processed by the bank
    - `chargeback_reversal` string — positive, amount in respect of chargebacks that were contested successfully
    - `adjustment` string — positive or negative, refers to adjustments that are agreed with the merchant
  - `charges` string — Amount of BillDesk charges for the transaction processing fees that are deducted from the total payout
  - `taxes` string — Amount of applicable taxes that are deducted from the total payout
  - `other_adjustments` string — Any other adjustment amounts, could be positive or negative
  - `payout_amount` string — Net Payout Amount that is settled to the merchant, and can be computed as - payout_amount = amount_details – charges – taxes +/- other_adjustments
  - `status` string — Refers to the status of the settlement object, and will take the following values: created – the settlement object is created, and sent to the bank for processing confirmed – when the UTR confirmation is received
  - `settlement_date` string — Date when the settlement object is created
  - `utr` string — Unique Transaction Reference (UTR) number that represents the inter-bank transfer instructions
  - `utr_date` string — Date when the UTR was sent

## Other responses

- `403` — Forbidden
- `500` — Internal Server Error
- `default` — Any bad or invalid request will lead to following error object

---

[API](https://skmtc.net/billdesk/apis/payments.md) · [All operations](https://skmtc.net/billdesk/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/billdesk/payments/revisions/43f021fc467f/schema)