Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Settlement

Retrieve Settlement

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

post/pasettlements/v1_2/settlements/get

Headers

BD-Traceidstring required
Example:20201203182838

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

BD-Timestampstring required
Example:20201203182838

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

Content-Typestring required
Example:application/json

Request Content-Type to take the values application/jose

Acceptstring required
Example:application/jose

Accept Response Content-Type to take the values application/jose

Request body

mercidstring

Unique identifier as defined by BillDesk for each merchant

from_datestring

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_datestring

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_numberstring

pv_number provided by BillDesk for the settlement This attribute is Mandatory if the ‘from_date’ is not provided.

Example request

{
  "mercid": "BDMERCID"
}

Response

OK

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_numberstring

Unique pv_number provided by BillDesk for the settlement

mercidstring

Unique identifier as defined by BillDesk for each merchant

payout_mercidstring

Unique identifier for the merchant assigned in respect of the payout

pv_filestring

Name of the file, referencing the PV

pv_file_datestring

Date of generation of the PV file

currencystring

ISO currency of the transaction amount, for INR this value will be 356

chargesstring

Amount of BillDesk charges for the transaction processing fees that are deducted from the total payout

taxesstring

Amount of applicable taxes that are deducted from the total payout

other_adjustmentsstring

Any other adjustment amounts, could be positive or negative

payout_amountstring

Net Payout Amount that is settled to the merchant, and can be computed as - payout_amount = amount_details – charges – taxes +/- other_adjustments

statusstring

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_datestring

Date when the settlement object is created

utrstring

Unique Transaction Reference (UTR) number that represents the inter-bank transfer instructions

utr_datestring

Date when the UTR was sent

Example response

[
  {
    "mercid": "BDMERCID"
  }
]