Retrieve Settlement

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

Body Params
string

Unique identifier as defined by BillDesk for each merchant

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

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.

string

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

Headers
string
required

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.

string
required

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.

string
required

Request Content-Type to take the values application/jose

string
required

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

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json