Search by keyword
/

Additional Features

Order Status

After registering an order, you can check its status in one of the following ways:

Example request:

curl -X POST 'https://api.uat.all2pay.net/v1/getOrderStatusExtended.do'
-H 'Content-Type: application/json' \
--data-raw '{
    "orderId": "5ab8fb6a-421e-4396-9bf8-d7d77cc1e706",
    "userName": "test_user",
    "password": "test_user_password"
}'

The structure of the response varies depending on whether the order is registered only in the Payment Service or has already been transferred to a bank.

The order status is represented by the state parameter. It can take the following values:

Example response for an order registered in the Payment Service:

{
    "state": "PREREGISTERED",
    "depositedAmount": 0,
    "orderStatusResultModel": {
        "allowedPaymentWays": [
            "CARD_BINDING",
            "CARD",
            "MIR_PAY"
        ],
        "amount": 247,
        "clientId": "259753456",
        "currency": "643",
        "date": 1730530148222,
        "depositFlag": "PURCHASE",
        "gwId": null,
        "gwOrderId": null,
        "failUrl": "http://mybestmerchantreturnurl.com",
        "hasTimeout": false,
        "merchantLogin": "test_user",
        "orderDescription": "Test order",
        "orderId": "8e4c2673-98e6-11ef-ab20-4989eedfa34b",
        "orderNumber": "1730530146_3302",
        "orderParams": {
            "paramE": "deposit"
        },
        "orderStatus": -1,
        "paymentWay": null,
        "successUrl": "https://mybestmerchantreturnurl.com"
    }
}

Example response for a successfully paid order:

{
    "state": "DEPOSITED",
    "depositedAmount": 920,
    "orderStatusResultModel": {
        "actionCode": 0,
        "actionCodeDescription": "",
        "amount": 920,
        "authDateTime": 1730537059726,
        "authRefNum": "152733574684",
        "bankInfo": {
            "bankName": "SBERBANK OF RUSSIA",
            "bankCountryCode": "RU"
        },
        "cardInfo": {
            "approvalCode": "123456",
            "cardholderName": "CARDHOLDER NAME",
            "expirationDate": "202412",
            "maskedPan": "427601**7761",
            "paymentSystem": "VISA"
        },
        "clientId": "259753456",
        "currency": "643",
        "date": 1730537058969,
        "depositFlag": "PURCHASE",
        "depositedDate": 1730537060295,
        "errorCode": "0",
        "errorMessage": "Success",
        "gwId": "SBERBANK",
        "gwOrderId": "e369c6ed-ea47-7b11-8087-bba24a87c214",
        "failUrl": "http://error.info?abc-123&def=567",
        "hasTimeout": false,
        "merchantLogin": "test_user",
        "operations": [
            {
                "amount": 920,
                "authCode": "123456",
                "cardHolder": "CARDHOLDER NAME",
                "currencyCode": "643",
                "operationDate": 1730537059726,
                "operationType": "PURCHASE",
                "maskedPan": "427601**7761",
                "processingResultCode": 0,
                "referenceNumber": "152733574684",
                "success": true,
                "terminalId": "22334477"
            }
        ],
        "orderDescription": "Monitored background synergy",
        "orderId": "954aab72-98f6-11ef-ab20-7d13eddab10a",
        "orderNumber": "1730537029_6667",
        "orderParams": {
            "binProductCategory": "CREDIT",
            "mdOrder_svip": "954aab72-98f6-11ef-ab20-7d13eddab10a",
            "paramE": "deposit",
            "paramF": "BG71MQIC844222679G7L4X",
            "binProductCode": "F"
        },
        "orderStatus": 2,
        "payerData": {
            "email": "Magdalena_Moen21@hotmail.com",
            "phone": "628-243-6459"
        },
        "paymentWay": "CARD",
        "processingId": "33224466",
        "refunds": [],
        "transactionAttributes": {
            "paymentNetRefNum": "ac4329d2-2031-416c-9e5b-836b5125c0c5"
        }
    }
}

Order Lifetime

By default, an order can be paid within 30 minutes after registration. You can specify a different session time in the sessionTimeoutSecs parameter during register.do order registration. The session time applies even if the payment is made via API without using the Payment Service payment page.

When using the payment page, after the session time expires, the payment page will no longer be accessible, and any attempt to open it will redirect to failUrl.

If the order is not paid within the session time and no payment attempts were made, the order status will become DECLINED with actionCode = -2007 without specifying a bank once the time expires. If the order is not paid within the session time but payment attempts were made, the order status will also be DECLINED with actionCode = -2007 but a bank will be specified. More about actionCodes can be found in Payment Response Codes.

Cancellations, Refunds

Cancellations

The payment service AntiDDOS Router supports the following methods for order cancellation:

Refund

The Payment service AntiDDOS Router supports the /refund.do API method to refund for a paid order (in DEPOSITED status).

The method features the following options:

Example of a partial refund by product items:

curl --location 'https://api.uat.all2pay.net/v1/refund.do' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 102729,
    "orderNumber": "1730538506_7044",
    "password": "test_user_password",
    "userName": "test_user",
    "refundItems": {
        "items": [
            {
                "positionId": "1",
                "name": "Advance Received",
                "quantity": {
                    "value": 1027.29,
                    "measure": "pcs"
                },
                "itemAmount": 102729,
                "itemCurrency": 643,
                "itemCode": "36035_10.1",
                "itemAttributes": {
                    "attributes": [
                        {
                            "name": "paymentMethod",
                            "value": "3"
                        },
                        {
                            "name": "paymentObject",
                            "value": "10"
                        }
                    ]
                },
                "tax": {
                    "taxType": "4"
                },
                "itemPrice": 100
            }
        ]
    }
}'

Example response:

{
    "errorCode": 0,
    "errorMessage": "Successful"
}

Two-phase payments

Types of payment

A company may use two types of payments, depending on the specifics of its business:

The amount to be debited may be less than the amount that was held. Debits exceeding the held amount are available as well (with configurable limits). If you need this feature please contact our Support Service.

Two-phase payments should be used if some time elapses between the buyer's decision to pay and delivery of the selected good or service.

For the payment to be a two-phase payment, the order must be registered via registerPreAuth.do, not register.do.

With instantPayment.do method, the payment type (one- or two-phase) is set by the preAuth parameter.

Two-phase payment is suitable for any method of integration:

However, SBP has some limitations for two-phase payments. Learn more at Two-phase payments with SBP

The Partner must have permission for two-phase payment in the bank to which the payment is routed.

Captures

A capture of a pre-authorized amount happens in the second phase of the two-phase payment, when the funds are debited from card holder's account. Once the capture occurs, the order becomes completed and goes in the DEPOSITED status. The amount captured can be greater or less than the pre-authorization amount, and partial capture in increments is available as well. If you do not pass the amount, then the full amount will be executed.

The capture is performed via the deposit.do method.

To cancel an authorized but not yet completed order, use the reverse.do method. The Partner must have permission for reversal in the bank to which the payment is routed.

It is available to do a partial capture. It will be less than the order amount and immediately final.

Autocompletion and autoreversal

If you have this feature enabled for you by our support team, you can set up your payment integration so that all preauthorized (Approved) two-phase orders would be completed or reversed automatically after a specific time period. This means that you don't have to call deposit.do or /reverse.do API methods.

To set the period after which the order will be automatically confirmed or cancelled, in the order registration request register.do pass the autocompletionDate or autoReverseDate parameter correspondingly.

Categories:
router API V1
Categories
Search results
Navigate
Select
Close
Categories
Search results