JIjiopay
Settlements

List all settlements

Returns a list of your settlements. The settlements are returned sorted by creation date, with the most recent settlement appearing first.

get/api/v1/settlements

Request

  • Base URL
    https://api.crossborder.jiopay.co.in
  • URL
    https://api.crossborder.jiopay.co.in/api/v1/settlements
  • Auth
    HTTP bearer

Query parameters

beforestring
Example:2025-02-18T12:03:44Z

ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid the page drift issue. See Pagination parameters for more details.

afterstring
Example:2025-01-18T12:03:44Z

ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid the page drift issue. See Pagination parameters for more details.

per_pageinteger
Example:20

Number of resources per page. Should be between 1 and 100.

pageinteger
Example:1

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Response

OK

Example response

{
  "data": [
    {
      "id": "setl_6878e266jt1P3",
      "status": "success",
      "payment_method": "swift_transfer",
      "amount": 1000,
      "currency": "USD",
      "fees": {
        "fx_fee": {
          "amount": 1000,
          "currency": "USD"
        },
        "txn_fee": {
          "amount": 1000,
          "currency": "USD"
        }
      },
      "utr": "1568176960vxp0rj",
      "created_at": "2024-12-06T11:38:37.130Z",
      "updated_at": "2024-12-06T11:38:37.130Z"
    }
  ],
  "page_meta": {
    "current": 2,
    "previous": 1,
    "next": 3,
    "per_page": 20,
    "pages": 10,
    "count": 200
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.