Create a new settlement

API reference

Request

Withdraws an amount from one of your currency balances to the withdrawal account registered for that currency, and returns the resulting settlement in pending.

Only available to businesses on manual settlement mode. On automatic settlement mode Glomo initiates settlements for you and this call returns 403 — it is not a way to pull a settlement forward.

The destination is not something you choose per request. There is no account field: the withdrawal account already registered against balance_currency is used, and a currency with no registered withdrawal account returns 404. To settle to a different bank, change the registered withdrawal account rather than the request.

Send balance_currency in upper case. Unlike most currency parameters on this API it is matched exactly, so a lower-case code will not find your withdrawal account and returns the same 404.

Security

JWT

Bodyapplication/jsonrequired

Provide both the amount and the balance_currency.

amountnumber, >= 1required

The amount to settle, in the smallest unit of balance_currency (paise for INR, cents for USD). 1000 is $10.00 when balance_currency is USD. A fractional value is truncated to a whole number.

Example:1000

balance_currencystring, (iso-4217)required

The balance you want to settle from, as an upper-case ISO 4217 code such as USD. The amount is deducted from this balance. It must match the currency of an active withdrawal account on your account, and the match is exact: a lower-case code, or a currency with no active withdrawal account, returns 404 with Withdrawal account not found.

Example:"USD"

curl -i -X POST \
  https://api.glomopay.com/api/v1/settlements \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 1000,
    "balance_currency": "USD"
  }'

Responses

Settlement created successfully

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