Skip to main content

Glossary

Appeal. A request to review an order that closed without a credit although the customer paid. Opened by you, resolved by the platform. Id prefix apl_.

Callback. The signed POST we make to your server when an order changes state. Also called a webhook elsewhere.

Callback URL. Where callbacks go: notifyUrl on the order, or the cash desk's URL.

Cascade. The routing that tries providers for an order in the order of their current score, skipping paused and failing ones.

Cash desk. One integration: a key and a secret, one payment method, allowed rails and currencies, a callback URL, amount limits and a tariff. Id prefix shp_.

Credited. The USD amount added to your balance for a completed order: the settlement amount minus the fee.

Event id. X-Gate-Event-Id, the identity of a callback event across all attempts to deliver it. Prefix evt_.

Fee. The platform's percentage of the settlement amount, from the cash desk's tariff.

Key. X-Gate-Key, the public identifier of a cash desk. Not secret.

Method. The family of a payment: Classic, WhiteTriangle, MobileCommerce, CrossBorder, Monobank, Counterparty, NspkQr. Fixed per cash desk.

Nonce. X-Gate-Nonce, a random string that makes each signed request unique within the replay window.

Order. One payment by one customer. Id prefix ord_.

Order reference. orderRef, your own identifier for an order. Idempotency key for one hour per cash desk.

Payment details. What the customer pays to: a phone number, a card number, an account, or a page URL, valid until expiresAt.

Payment page. Our public page at /payment/{orderId} that shows the details and the countdown to the customer.

Provider. An upstream that actually moves the money. You never see which one served an order.

Rail. The route within a method: Sbp, C2c, Phone, or none for methods with a single route. Under CrossBorder the rail is the country's instrument: Upi, Account, Iban, Havale, Kaspi, Uzcard, Humo, plus C2c and Phone.

UTR. Unique Transaction Reference, the number an Indian bank issues for a UPI transfer. The customer reports it on our payment page; it reaches you as payerReference.

Rate. Units of the customer's currency per one USD, spread included, captured at creation as settled.rate.

Sandbox. The test provider that takes every order from an unapproved account and moves no money. Its outcome is simulated from the cabinet.

Secret. The cash desk's signing secret. Shown once; signs requests and callbacks.

Settlement. Everything the platform credits, in USD.

Support account. A colleague's login under your account with everything except access management and withdrawals.

Trace id. traceId, the identifier of a request in the platform's logs.

Turnover limit. A USD cap per cash desk, merchant, provider or platform, per hour, day or month, on completed orders.