Methods, rates and balance

Three read-only calls that tell you what an order can look like before you create it. None of them is rate limited beyond the signature check.

What the cash desk can accept

GET /gw/v1/methods

A live picture: it accounts for the cash desk's own switches, its rail and currency restrictions, provider pauses and, for an account under review, the sandbox-only rule.

{
  "status": "ok",
  "result": {
    "method": "Classic",
    "available": true,
    "reason": null,
    "rails": [
      { "rail": "Sbp", "currencies": [ { "code": "RUB", "min": 100, "max": 300000 } ] },
      { "rail": "C2c", "currencies": [ { "code": "RUB", "min": 100, "max": 150000 } ] }
    ]
  }
}

min and max are in the customer's currency and describe the widest window any provider currently offers; 0 means unbounded. Your own cash desk limits, in USD, apply on top.

When available is false, reason says why: "shop inactive" when you disabled the cash desk, the stop reason when the platform stopped it, or "no provider currently offers this method" when every provider for the method is paused or has no capability for the rails and currencies the cash desk allows.

Ask before creating an order so you do not spend attempts, and your customer's patience, on a channel that is closed right now.

Methods and rails

Method	Rails	What the customer does
Classic	Sbp, C2c	Transfers by SBP to a phone number, or to a card number.
WhiteTriangle	Sbp, C2c	The same mechanics on a different pool of payment details.
MobileCommerce	Phone	Pays from a mobile phone balance. Pass operator on the order.
CrossBorder	see below	Customers outside Russia. The rail is the country's instrument; the country follows from the currency.
Monobank	none	Pays through Monobank.
Counterparty	none	Business-to-business transfer to a legal entity's account.
NspkQr	none	Scans an NSPK QR code.

CrossBorder rails

Rail	Country, currency	What the customer does	payment keys
Upi	India, INR	Scans a UPI QR or pays to a UPI id, then reports the UTR from their bank.	upiId, holder
Account	Korea, KRW	Bank transfer to an account number.	account, holder, bank
Iban	Turkey, TRY	Interbank transfer to an IBAN.	iban, holder, bank
Havale	Turkey, TRY	Transfer to an IBAN within the same bank.	iban, holder, bank
C2c	Azerbaijan AZN (M10 to card), Kazakhstan KZT	Transfer to a card number.	card, holder, bank
Phone	Kazakhstan, KZT	Transfer to a phone number.	phone, holder, bank
Kaspi	Kazakhstan, KZT	Kaspi transfer: card number and phone number shown together.	card, phone, holder
Uzcard	Uzbekistan, UZS	Transfer to an UZCARD card.	card, holder, bank
Humo	Uzbekistan, UZS	Transfer to a HUMO card.	card, holder, bank

A cross-border cash desk is usually one country: one or two rails and that country's currency. GET /gw/v1/methods lists only the rails a provider currently offers in the currencies the cash desk allows, so a desk with Kaspi and KZT sees Kaspi when a Kazakh provider is live and an empty list when none is.

A cash desk is bound to one method for its whole life. Rails within the method can be restricted on the cash desk; with several allowed you must pass rail on every order.

Rates

GET /gw/v1/rates
GET /gw/v1/rates?currency=RUB

{
  "status": "ok",
  "result": {
    "settlement": "USD",
    "rates": [
      { "code": "RUB", "rate": "91.40000000", "priceable": true },
      { "code": "KZT", "rate": null, "priceable": false }
    ]
  }
}

rate is units of the currency per one USD, spread included: the value here is exactly the one an order created now would settle at. Only currencies the cash desk allows are listed. priceable: false means the currency is known but cannot be priced right now; an order in it answers FX_RATE_UNAVAILABLE.

Rates come from market sources refreshed every minute for RUB and every ten minutes for the rest, with a sanity check against sudden jumps. The platform may set a manual rate for a currency; when it does, that rate takes precedence.

Balance

GET /gw/v1/balance

{ "status": "ok", "result": { "currency": "USD", "available": "1523.40000000" } }

The merchant's balance in the settlement currency, shared by all cash desks of the account. It grows when an order completes, by the credited amount, and shrinks on a withdrawal or a reversal. The full history, with a link to the order behind each line, is on the Balance page of the cabinet. Withdrawals are arranged with support.