POST
/
api
/
v2
/
settlement
/
fetch
curl --request POST \
  --url https://api.paytring.com/api/v2/settlement/fetch \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "<string>",
  "date": "2023-12-25",
  "pg": "<string>",
  "offset": "<string>",
  "limit": "<string>"
}'
"{\n    \"status\": true,\n    \"data\": [\n    {\n            \"order_id\": null,\n            \"pg_transaction_id\": \"xxxx83793xxxxxxxxx\",\n            \"order_date\": \"2xxx-0x-xx 2x:0x:xx\",\n            \"utr\": \"xxxx4791xxxxxx\",\n            \"settlement_date\": \"2xxx-0x-xx 00:xx:00\",\n            \"order_status\": \"success\",\n            \"pg_status\": \"Shipped\",\n            \"payment_mode\": \"UPI\",\n            \"amount\": 1xxxxxx,\n            \"mer_service_fee\": 0,\n            \"mer_service_tax\": 0,\n            \"merchant_subvention_amount\": \"0.00\",\n            \"cgst\": \"0.00\",\n            \"igst\": \"0.00\",\n            \"sgst\": \"0.00\",\n            \"settled_amount\": 1xxxxx,\n            \"dispute_id\": null,\n            \"description\": null\n        },\n    ],\n     \"is_last_page\": false, // If it is the last page, it will return true.\n    \"request_id\": \"67bf1xxxxxxx4\"\n}"

This API allows you to fetch settlement details by date.

​
Request Body

{
  "key": "string", // Merchant key, available in dashboard profile section
  "date": "string", // The date you want to fetch settlements for (format: YYYY-MM-DD)
  "pg": "string", // Payment gateway code (optional)
  "offset": "string", // Starting point for results (optional)
  "limit": "string" // Maximum number of records to return (optional)
}

​
Responses

​
200 OK

{
  "status": true,
  "data": [
    {
      "order_id": null,
      "pg_transaction_id": "string",
      "order_date": "string",
      "utr": "string",
      "settlement_date": "string",
      "order_status": "string",
      "pg_status": "string",
      "payment_mode": "string",
      "amount": 0,
      "settled_amount": 0
    }
  ],
  "is_last_page": false,
  "request_id": "string"
}

​
400 Bad Request

{
  "status": false,
  "error": {
    "message": "Invalid request",
    "code": 400
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
key
string
required

Merchant key, available in dashboard profile section

​
date
string
required

the date you want to fetch settlements for

​
pg
string
required

if you want to fetch details of a particular pg. only, please pass it's pg code

​
offset
string

It specifies the starting point from which to return results

​
limit
string

It specifies the maximum number of records to return in a response

Response

200
application/json
200

The response is of type any.