Reference¶
3D-Secure Status¶
| Status | Description |
|---|---|
| PASSED | 3DS passed |
| NOT_PASSED | 3DS not passed |
| WITHOUT | Not required |
Card Verification Status¶
Card verification status is returned in the response to the card verification request.
| Status | Description |
|---|---|
| INIT | Verification link created but the customer hasn’t used it yet |
| SUCCESS | Verification is successful |
| ERROR | Verification error |
| WAITING_3DS | Awaiting 3D Secure authentication completion |
Interface Types¶
Types of interfaces that can be used to create an invoice. May be transmitted in customFields.
| Interface type | Description |
|---|---|
| PUBLIC_KEY | Invoice created via payment link |
| PAYIN_API | Invoice created via API |
| KASSA | Invoice created via Merchant Portal |
Invoice Status¶
| Status | Description |
|---|---|
| CREATED | Invoice created |
| PAID | Invoice paid |
| EXPIRED | Invoice expired |
| CANCELED | Invoice cancelled |
Notification Status¶
Notification status is transmitted in {operation}.status.value. Notifications use SUCCESS for success and DECLINE for rejection. API responses use COMPLETED and DECLINED instead (see operation status). Possible statuses and operation types using those statuses are listed in the table.
| Operation type | Status | Description |
|---|---|---|
| PAYMENT | DECLINE | Request declined |
| PAYMENT | SUCCESS | Request processed successfully |
| CAPTURE | DECLINE | Request declined |
| CAPTURE | SUCCESS | Request processed successfully |
| REFUND | DECLINE | Request declined |
| REFUND | SUCCESS | Request processed successfully |
| REFUND | WAITING | Waiting for processing (more detailed) |
Operation Status¶
API returns the current status of an operation in status.value.
API responses always use COMPLETED for success and DECLINED for rejection. SUCCESS and DECLINE are used only in notifications.
Possible statuses and operation types using those statuses are listed in the table.
| Operation type | Operation status | Status description |
|---|---|---|
| PAYMENT | WAITING | Waiting for 3D-Secure authorization |
| PAYMENT | DECLINED | Authorization request declined |
| PAYMENT | COMPLETED | Authorization request processed successfully |
| CAPTURE | DECLINED | Capture declined |
| CAPTURE | COMPLETED | Capture completed successfully |
| REFUND | DECLINED | Refund declined |
| REFUND | COMPLETED | Refund completed successfully |
| REFUND | WAITING | Waiting for processing (more detailed) |
Operation Types¶
Operation type is returned in the {operation}.type parameter of a notification.
| Type | Description |
|---|---|
| PAYMENT | Payment. The notification may contain flags: [ "SALE" ] (regular payment) or flags: [ "AUTH" ] (payment with authorization) |
| CAPTURE | Capture operation |
| REFUND | Refund. The notification may contain flags: [ "REVERSAL" ]. This means that the finantial operation (debiting the customer’s account) did not happen, the fee will be cancelled |
Operation Types with Saved Card¶
The type of payment operation using a saved card may be transmitted in credentialOnFile.type parameter of the payment creation request
| Type | Description |
|---|---|
| CREDENTIAL_ON_FILE | Operation using a saved card, initiated by the customer |
| CREDENTIAL_CAPTURED | Operation with which the card information is saved for future payments |
| RECURRING | Operation using a saved card, initiated by the merchant |
| INSTALLMENT | Operation using a saved card, initiated by the merchant (only for MCC 6538) |
Parameters for Processing Transactions for Operations with a Saved Card¶
The parameter is transmitted in paymentMethod.cardTokenPaymentType field of the payment creation request and serves for the correct processing of transactions in pay,ent systems for operations with saved cards.
| Value | Payment method type | Description |
|---|---|---|
| FIRST_PAYMENT | Only for type=CARD |
Used if after this operation the merchant will save the card data on their side |
| INITIATED_BY_CLIENT | Для type=CARD, TOKEN |
Transaction on the saved card initiated by a client |
| INITIATED_BY_MERCHANT | Для type=CARD, TOKEN |
Transaction on the saved card initiated by the merchant |
| RECURRING_PAYMENT | Для type=CARD, TOKEN |
Recurring operation on the saved card |
| INSTALLMENT | Для type=CARD, TOKEN |
Repeated operation on the saved card in accordance with payment schedule for credit repayment |
Payment Method Types¶
Payment method type is returned in the {operation}.paymentMethod.type parameter of a notification.
| Type | Description |
|---|---|
| CARD | Bank card |
| TOKEN | Payment token |
| SBP | Faster payments system |
| YANDEX_PAY | Yandex Pay |
| SBER_PAY | Sber Pay |
| QPLUS | Qplus |
QR Code Status¶
QR code status is transmitted in qrCode object parameters in response to the following requests: “Creating a QR Code for FPS” и “Retrieving FPS QR Code Information”. Possible QR code statuses depend on the QR code type.
| Status | QR code type | Description |
|---|---|---|
| CREATED | All types | QR code created |
| DECLINED | DYNAMIC, TOKEN |
Payment declined |
| EXPIRED | DYNAMIC |
QR code expired |
| PARTIAL_REFUNDED | DYNAMIC |
Partially refunded |
| REFUNDED | DYNAMIC |
Completely refunded |
| PAYED | DYNAMIC |
Paid |
| INIT_PAYMENT_BY_TOKEN | TOKEN |
Initiated a payment with the token |
| TOKENIZED | TOKEN |
Successful tokenization |
QR Code Types¶
QR code type is transmitted in qrCode object parameters in the request for creating a QR Code for FPS and the response to the request.
| Type | Description |
|---|---|
| STATIC | Static QR code |
| DYNAMIC | Dynamic QR code, unique for every payment |
| TOKEN | Used to issue an FPS payment token |
Yandex Pay Order Statuses¶
Yandex Pay order status is returned in the response to the creating a Yandex Pay order and retrieving Yandex Pay order information requests.
| Status | Description |
|---|---|
| CREATED | Created |
| PAYED | Payid |
| DECLINED | Declined |
Yandex Pay Payment Statuses¶
Yandex Pay payment status is returned in the response to the retrieving Yandex Pay order information request.
| Status | Description |
|---|---|
| COMPLETED | Payment processed successfully |
| DECLINED | Payment declined |
Qplus Invoice Statuses¶
Qplus invoice status is returned in the response to the creating a Qplus invoice and retrieving Qplus invoice information requests.
| Status | Description |
|---|---|
| CREATED | Created |
| PAYED | Paid |
| FAILED | Error |
Qplus Payment Statuses¶
Qplus payment status is returned in the response to the retrieving Qplus invoice information request.
| Status | Description |
|---|---|
| COMPLETED | Payment processed successfully |
| DECLINED | Payment declined |