Skip to content
Docs/
API reference
/
/
Retrieve a settlement

Retrieve a settlement

Request

Returns a specific settlement by its unique identifier.

Security
JWT
Path
idstringrequired

The unique identifier of the settlement. Starts with setl_ followed by letters and digits. An ID of any other shape is rejected with 400 and a message saying it must start with setl_; a well-formed ID that doesn't match a settlement on your account returns 404.

Example:setl_6878e266jt1P3
curl -i -X GET \
  https://api.glomopay.com/api/v1/settlements/setl_6878e266jt1P3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Settlement found

Bodyapplication/json
idstringread-only

The unique identifier for the settlement.

Example:"setl_6878e266jt1P3"
statusstring

The status of the settlement.

Example:"success"
payment_methodstring

The payment method used for the settlement.

Example:"swift_transfer"
amountnumber, >= 1

The amount of the settlement, in the smallest unit of currency (paise for INR, cents for USD). 1000 is $10.00 when currency is USD.

Example:1000
currencystring, (iso-4217)

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

Example:"USD"
feesobject

The fees associated with the settlement.

utrstring

The Unique Transaction Reference (UTR) for the settlement.

Example:"1568176960vxp0rj"
created_atstring, (date-time)read-only

When the settlement was created, as an ISO 8601 date-time in UTC.

Example:"2024-12-06T11:38:37.130Z"
updated_atstring, (date-time)read-only

When the settlement was last updated, as an ISO 8601 date-time in UTC.

Example:"2024-12-06T11:38:37.130Z"
Response
{
  "id": "setl_6878e266jt1P3",
  "status": "success",
  "payment_method": "swift_transfer",
  "amount": 1000,
  "currency": "USD",
  "fees": {
    "fx_fee": { … },
    "txn_fee": { … }
  },
  "utr": "1568176960vxp0rj",
  "created_at": "2024-12-06T11:38:37.130Z",
  "updated_at": "2024-12-06T11:38:37.130Z"
}