JIjiopay
Settlements

Retrieve a settlement

Returns a specific settlement by its unique identifier.

get/api/v1/settlements/{id}

Request

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

Path parameters

idstring required
Example:setl_6878e266jt1P3

The unique identifier of the settlement

Response

OK

idstring

The unique identifier for the settlement.

statusstring

The status of the settlement.

payment_methodstring

The payment method used for the settlement.

amountnumber

The amount of the settlement in cents. For example, 1000 cents is $10.00. The currency is determined by the currency field.

currencystring

The currency in which the settlement is made. The currency code is in ISO 4217 format. For example, USD.

utrstring

The Unique Transaction Reference (UTR) for the settlement.

created_atstring

The creation timestamp of the settlement.

updated_atstring

The last update timestamp of the settlement.

Example response

{
  "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"
}

Changes

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