| Header | Type | Required | Description |
|---|---|---|---|
X-Public-Key | string | required | The merchant's public API key. Must be included in every request and is used together with X-Secret-Key to authenticate the client. |
X-Secret-Key | string | required | The merchant's secret API key. Must be included in every request to authenticate the client. Keep this key secure and never expose it in client-side applications. |
Idempotency-Key | string | required | A unique identifier for the request used to ensure idempotent operations. Repeating a request with the same idempotency key returns the original result instead of creating a duplicate operation. Each key should be unique for every create or cancel request. |
| Field | Type | Required | Description |
|---|---|---|---|
amount | string | required | Payment amount represented as a decimal string (e.g. 100.50). Must be greater than 0. |
currency | string | required | Payment currency in ISO 4217 format (e.g. UAH, EUR, USD). |
amount_tolerance_up | string | optional | Maximum allowed overpayment amount. Payments exceeding amount + amount_tolerance_up will be rejected. If omitted, overpayments are not allowed. |
expires_in | integer | optional | Lifetime of the payment request in seconds. Once expired, the assigned payment requisites become invalid and can no longer be used. |
requisite | object | required | Criteria used to select the payment requisites that will be assigned to the customer. |
customer | object | required | Customer information used for fraud detection, risk assessment, and payment routing. |
metadata | object | optional | Arbitrary key-value data associated with the payment. This information is stored and returned in API responses and webhooks but is not processed by the system. |
| Field | Type | Description |
|---|---|---|
id | string | Unique payment identifier in the system. |
type | string | Operation type. For this endpoint, usually payment, payout. |
requested | object | Original amount and currency requested by the merchant. |
initialized | object | Amount and currency initialized by the system after applying routing, limits, or tolerance rules. |
processed | object | Amount and currency actually processed after payment confirmation. |
refunded | object | Amount and currency that has been refunded. If no refund was made, the amount is usually 0. |
requisite | object | Payment requisites assigned to the customer for completing the payment. |
status | string | Current payment status, for example created, processing, partially_completed, completed, declined, expired, partially_refunded, refunded, or canceled. |
expires_at | string | Date and time when the payment expires. Usually returned in ISO 8601 format. |
created_at | string | Date and time when the payment was created. Usually returned in ISO 8601 format. |
updated_at | string | Date and time when the payment was last updated. Usually returned in ISO 8601 format. |
metadata | object | Custom merchant data passed during payment creation. Returned without modification. |