WEBPAY

https://docs.webpay.by
Admin
WEBPAY is an online payment service that provides merchant integration tools, APIs, and payment...
Tokens:65,579
Snippets:255
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Halva+ Payment Response Example

Source: https://docs.webpay.by/merchantPCIDSS/PCIDSSPaymentFormation

This is an example of the response received from WEBPAY when a Halva+ card payment is initiated. It includes tokens and available payment options.

```json
{
  "token":"effc84c25f202e28dd96b3197d682bfe611dd2e8e67233f46114094940a05fcf=73444a4f5f39324b764b767476517876622d647372676b49744444534c4d5a303458
79566e334b48526e592c",
  "tokenName":"wt",
  "availableOption":"ipsPayment,halva",
  "paymentType":""
}
```

--------------------------------

### Webpay by Payment Request Example

Source: https://docs.webpay.by/merchantPCIDSS/PCIDSSPaymentFormation

This JSON object represents a sample POST request to the Webpay by API for initiating a payment. Ensure all fields, especially 'wsb_encrypted_data' and 'wsb_signature', are correctly generated.

```json
{
  "wsb_storeid":"123456789",
  "wsb_currency_id":"BYN",
  "wsb_version":2,
  "wsb_seed":"1242649174",
  "wsb_test":0,
  "wsb_invoice_item_name":["test"],
  "wsb_invoice_item_price":["0.1"],
  "wsb_invoice_item_quantity":["1"],
  "wsb_operation_type":"",
  "wsb_customer_id":"41432",
  "wsb_encrypted_data":"VYs5XZYA79BORvcPW4LbBM6x4B36lBnQskF7j61UVlsH4ENPrPCs1exkJdCF6fX9nyENvrC434w3tL6HBtY7mxFXFvMBbsNoDbF4OC4lJEPVSSoBASLZH/9M1hBtavKjjDyKWXsCd5HYihp6PRTs3rMtw9+6Dao8hyfucMxyGpzDU/fW7DZdZ1GY3RIRKXJgPOP/AWv1YORy22BtyNs461CKuyXVY5AdeLO7WmV2x9kxexKNncKO4o0voy9KjW/nYj7R1YCQAZ4k1G2ZuXku90+yeo/AVBCXVTOEejwfplw9dFARes6OtQcW10kQmTdMi9200bf3sY2lQ1UZSbNMRw==",
  "wsb_order_num":"ORDER-de35",
  "wsb_total":"0.1",
  "wsb_signature":"87943d79649e10970b23dfd41194e5a503292bba",
  "wsb_tax":"0",
  "wsb_shipping_name":"Стоимость доставки",
  "wsb_shipping_price":"0",
  "wsb_discount_name":"Скидка на товар",
  "wsb_discount_price":"0",
  "wsb_email":"test@test.com",
  "wsb_phone":"",
  "wsb_return_url":"https://test.com/return",
  "wsb_cancel_return_url":"https://test.com/cancel",
  "wsb_notify_url":"https://test.com/",
  "wsb_3ds_payment_option":"auto",
  "*scart":""
}
```

--------------------------------

### WEBPAY JSON Request Example

Source: https://docs.webpay.by/paymentIntegration/createOrderAPI

This JSON object represents a sample request to the WEBPAY payment system. It includes all necessary fields for a transaction, such as order details, customer information, items, and URLs.

```json
{
  "resourceId": 479447789,
  "resourceOrderNumber": "455444556222",
  "validThrough": "2017-09-25T00:01:00+03:00",
  "shortDescription": "Test payment",
  "creationTime": "2017-09-20T09:00:00+03:00",
  "longDescription": "This is a test payment",
  "languageCode": "ru",
  "customer": {
    "resourceCustomerId": "test33332",
    "phone": "375331231231",
    "email": "test@test.by",
    "name": "tttttt",
    "surname": "qqqqqqq"
  },
  "items": [
    {
      "idx": 1,
      "name": "Товар 1 UTF-8 1",
      "quantity": "1",
      "price": {
        "currency": "BYN",
        "amount": 130.1
      }
    },
    {
      "idx": 2,
      "name": "Product 2",
      "quantity": 1,
      "price": {
        "currency": "BYN",
        "amount": 40.1
      }
    }
  ],
  "total": {
    "currency": "BYN",
    "amount": 170.2
  },
  "discounts": [
    {
      "name": "discount",
      "promoCode": "promo code",
      "type": "type",
      "value": {
        "amount": 10.1,
        "currency": "BYN"
      }
    }
  ],
  "shippings": [
    {
      "name": "shipping",
      "value": {
        "amount": 10.1,
        "currency": "BYN"
      }
    }
  ],
  "urls": {
    "resourceReturnUrl": "http://localhost:8080/return11111",
    "resourceCancelUrl": "http://localhost:8080/cancel22222",
    "resourceNotifyUrl": "http://192.168.44.11:8080/webpay/shop"
  }
}
```

--------------------------------

### Merchant Site Return URL Example

Source: https://docs.webpay.by/payment-json.html

This is the merchant's site URL for handling customer returns after a successful payment. It includes order and transaction identifiers.

```http
https://merchant_site/return?wsb_order_num={wsb_order_num}&wsb_tid={wsb_tid}
```

--------------------------------

### GET /websites/webpay_by/return_url

Source: https://docs.webpay.by/payment-json.html

Handles the return of a payer to the merchant's site after payment.

```APIDOC
## GET /websites/webpay_by/return_url

### Description
Handles the return of a payer to the merchant's site after payment.

### Method
GET

### Endpoint
/websites/webpay_by/return_url

### Parameters
#### Query Parameters
- **transaction_id** (string) - Required - The transaction ID.
- **status** (string) - Required - The payment status ('success' or 'failure').
- **payment_id** (string) - Optional - The unique payment identifier from WEBPAY.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "message": "Payment processed successfully. Thank you!"
}
```
```

--------------------------------

### Successful Return URL Example

Source: https://docs.webpay.by/payment-json.html

This is the gateway's success response URL when a customer returns after a successful payment. It includes order and transaction identifiers.

```http
get/return?wsb_order_num={wsb_order_num}&wsb_tid={wsb_tid}
```

--------------------------------

### Unsuccessful Return URL Example

Source: https://docs.webpay.by/payment-json.html

This is the gateway's success response URL when a customer returns after an unsuccessful payment. It includes the order identifier.

```http
get/cancel?wsb_order_num={wsb_order_num}
```

--------------------------------

### Webpay by Payment Response Example

Source: https://docs.webpay.by/merchantPCIDSS/PCIDSSPaymentFormation

This JSON object shows a typical response from the Webpay by API after a payment request. It contains fields like 'acsUrl', 'PaReq', and 'MD' which are crucial for the 3D Secure authentication process.

```json
{
  "data":{
    "token":"92a9c54404799d7a08634b0edf224f4d=634574725331424c6454684e57574a574e6c5669523068794e3352545a5339355756564f646e4a704d47356b5548686b595664794e79394e55444245526e4934646b355957697448574642686355394d6479394864512c2c",
    "tokenName":"wt",
    "time":"",
    "orderNumber":"",
    "invoiceNumber":"",
    "transaction":"",
    "authorizationCode":"",
    "rrn":"",
    "trimPan":"",
    "payee":"",
    "amount":"",
    "currency":"",
    "responseCode":"",
    "responseText":"",
    "acsUrl":"https:\/\/ucas.npc.by:8443\/pareq\/194978586\/ceb25c48-69f4-4aec-a069-6f5a8f65cd0d\/",
    "PaReq":"eJxVUctSwkAQvPsVFB\/AvmBJqGEpNJZyMKBiWXpbNlOQkoSQhwa+3t0QBG\/dvTM9Oz0wqZNt5xvzIt6l4y7r0e5E3cBykyMGr2iqHBU8YVHoNXbiyFZ4xhdGeN5wIKX2GDNU+1x4EdWR56M0\/mAoqWZdBYvpC+4VtObKevc4kDO1rrnZ6LRUoM3+dhYqnzHOBJCWQoL5LFBccs6temKQ6gTVO64yfQDSEDC7Ki3zg7LtQM4EqnyrNmWZjQj5acp7K9vhVCCX0YvKocK61HGkwmDKPpP7fnjcfs2Dt2P48Fx\/LNf9eTAbA3EVEOkSFadcUMllh\/ERlSPhA2l00Ikbryijdo0ThsyNmF49XAtgE84xNQflC7vkHwOss12KtsLu9IchwsIQu8Dl23ePLj9T2mwY9RilnLsEG8GZxDYLPqSicXEEiGsh7XFIe1uL\/t38FyiprZE=",
    "MD":"92a9c54404799d7a08634b0edf224f4d=634574725331424c6454684e57574a574e6c5669523068794e3352545a5339355756564f646e4a704d47356b5548686b595664794e79394e55444245526e4934646b355957697448574642686355394d6479394864512c2c",
    "TermUrl":"https:\/\/payment.webpay.by\/?wt=48957735ca99cdb589ef07753ebaaef5=5255737a5a5539684b335a484f456c594b326b34537a6c59566c6c6e5233684d5a314a6b656b355159335934555734776447313662584e4555325645544459305430396c6545394b543152694c3273344d6b6b3454412c2c"
  }
}
```

--------------------------------

### Webpay Notification Request Sample

Source: https://docs.webpay.by/payment-json.html

Example of a successful gateway notification response sent to the merchant's wsb_notify_url. This payload is typically sent as application/x-www-form-urlencoded.

```http
{batch_timestamp=1562591640&currency_id=USD&amount=300&payment_method=cc&order_id=127386&site_order_id=16&transaction_id=858578101&payment_type=4&rrn=786755995452&wsb_signature=001a1e46c8ba6c9934dc60975ecc9f75&action=0&rc=W0001%2800%29&approval=786755&country_alpha_three_code=USA&issuer_promo_product=1}
```

--------------------------------

### Merchant Site Cancel Return URL Example

Source: https://docs.webpay.by/payment-json.html

This is the merchant's site URL for handling customer returns after an unsuccessful payment. It includes the order identifier.

```http
https://merchant_site/cancel?wsb_order_num={wsb_order_num}
```

--------------------------------

### HTML Form for Installment Payments

Source: https://docs.webpay.by/paymentIntegration/installmentCards

Use this HTML form to submit payment details for installment cards. Ensure the `wsb_terminal` parameter is correctly set for the desired installment plan. The signature calculation must include `wsb_terminal`.

```html
<form action="https://securesandbox.webpay.by/" method="post">
  <input type="hidden" name="*scart">
  <input type="hidden" name="wsb_version" value="2">
  <input type="hidden" name="wsb_language_id" value="russian">
  <input type="hidden" name="wsb_storeid" value="11111111">
  <input type="hidden" name="wsb_store" value="Название Вашего магазина">
  <input type="hidden" name="wsb_order_num" value="ORDER-12345678">
  <input type="hidden" name="wsb_test" value="0">
  <input type="hidden" name="wsb_currency_id" value="BYN">
  <input type="hidden" name="wsb_seed" value="1242649174">
  <input type="hidden" name="wsb_return_url" value="http://yoursiteurl.com/success.php">
  <input type="hidden" name="wsb_cancel_return_url" value="http://yoursiteurl.com/cancel.php">
  <input type="hidden" name="wsb_notify_url" value="http://yoursiteurl.com/notify.php">
  <input type="hidden" name="wsb_invoice_item_name[0]" value="Товар 1">
  <input type="hidden" name="wsb_invoice_item_quantity[0]" value="2">
  <input type="hidden" name="wsb_invoice_item_price[0]" value="10">
  <input type="hidden" name="wsb_invoice_item_name[1]" value="Товар 2">
  <input type="hidden" name="wsb_invoice_item_quantity[1]" value="1">
  <input type="hidden" name="wsb_invoice_item_price[1]" value="0.5">
  <input type="hidden" name="wsb_total" value="20.90">
  <!-- Значение SecretKey в примере равно 1 -->
  <input type="hidden" name="wsb_signature" value="950f99293b3aa0d26ab11f69af7f4ba5441e42b5">
  <input type="hidden" name="wsb_shipping_name" value="Стоимость доставки">
  <input type="hidden" name="wsb_shipping_price" value="0.98">
  <input type="hidden" name="wsb_discount_name" value="Скидка на товар">
  <input type="hidden" name="wsb_discount_price" value="0.58">
  <input type="hidden" name="wsb_terminal" value="80000003">
  <input type="submit" value="Купить">
</form>
```

--------------------------------

### GET /api/operations/get_transaction_status_by_id

Source: https://docs.webpay.by/payment-json.html

Retrieves the status of a transaction using its transaction ID.

```APIDOC
## GET /api/operations/get_transaction_status_by_id

### Description
Retrieves the status of a transaction using its transaction ID.

### Method
GET

### Endpoint
/api/operations/get_transaction_status_by_id

### Parameters
#### Query Parameters
- **transaction_id** (string) - Required - The unique transaction identifier.

### Request Example
```
GET /api/operations/get_transaction_status_by_id?transaction_id=12345abc
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the transaction.
- **transaction_id** (string) - The transaction ID.
- **amount** (number) - The transaction amount.
- **currency** (string) - The transaction currency.

#### Response Example
```json
{
  "status": "completed",
  "transaction_id": "12345abc",
  "amount": 100.50,
  "currency": "BYN"
}
```
```

--------------------------------

### POST /woc/order (Test and Live)

Source: https://docs.webpay.by/paymentIntegration/createOrderAPI

API for creating orders in the WEBPAY system. This service allows you to create orders in the WEBPAY system via API. Requests are sent using the POST method to the specified URLs. Each request must be signed using the Hmac algorithm.

```APIDOC
## POST /woc/order

### Description
API for creating orders in the WEBPAY system without redirecting to the payment page. This functionality requires prior activation by contacting WEBPAY technical support.

### Method
POST

### Endpoint
- Test: `https://sand-box.webpay.by/woc/order`
- Live: `https://api.webpay.by/woc/order`

### Parameters

#### Request Body
(The request body structure is not detailed in the provided text, but it is implied that it contains order details and is signed.)

### Request Example
(No specific request example is provided in the text.)

### Response
(Success and error response details are not provided in the text.)

### Note
Each request must be signed according to the `Hmac` algorithm. The description of this algorithm is provided separately.
```

--------------------------------

### GET /api/operations/get_transaction_status_by_order_id

Source: https://docs.webpay.by/payment-json.html

Retrieves the status of a transaction using its order ID.

```APIDOC
## GET /api/operations/get_transaction_status_by_order_id

### Description
Retrieves the status of a transaction using its order ID.

### Method
GET

### Endpoint
/api/operations/get_transaction_status_by_order_id

### Parameters
#### Query Parameters
- **order_id** (string) - Required - The unique order identifier.

### Request Example
```
GET /api/operations/get_transaction_status_by_order_id?order_id=order_xyz789
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the transaction.
- **transaction_id** (string) - The transaction ID.
- **amount** (number) - The transaction amount.
- **currency** (string) - The transaction currency.

#### Response Example
```json
{
  "status": "pending",
  "transaction_id": "txn_12345abc",
  "amount": 50.00,
  "currency": "USD"
}
```
```

--------------------------------

### GET /api/payouts/mtbank/get_transaction_status

Source: https://docs.webpay.by/payment-json.html

Retrieves the status of a P2P payout transaction via MTBank.

```APIDOC
## GET /api/payouts/mtbank/get_transaction_status

### Description
Retrieves the status of a P2P payout transaction via MTBank.

### Method
GET

### Endpoint
/api/payouts/mtbank/get_transaction_status

### Parameters
#### Query Parameters
- **transaction_id** (string) - Required - The transaction ID of the payout.

### Request Example
```
GET /api/payouts/mtbank/get_transaction_status?transaction_id=txn_mtb_abc123
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the transaction (e.g., 'pending', 'completed', 'failed').
- **transaction_id** (string) - The transaction ID.

#### Response Example
```json
{
  "status": "completed",
  "transaction_id": "txn_mtb_abc123"
}
```
```

--------------------------------

### POST /websites/webpay_by - Recurring Payment Initiation

Source: https://docs.webpay.by/payment-json.html

Initiates a recurring payment (Card-on-File) by sending a POST request with the necessary transaction details.

```APIDOC
## POST /websites/webpay_by

### Description
Initiates a recurring payment (CoF) by sending a POST request with the necessary transaction details.

### Method
POST

### Endpoint
/websites/webpay_by

### Parameters
#### Request Body
- **wsb_storeid** (string) - Required - Your store ID.
- **wsb_order_num** (string) - Required - Unique order number.
- **wsb_currency_id** (string) - Required - Currency code (e.g., BYN).
- **wsb_version** (integer) - Required - API version.
- **wsb_seed** (string) - Required - A unique seed for signature generation.
- **wsb_test** (integer) - Optional - Test mode indicator (1 for test, 0 for live).
- **wsb_invoice_item_name** (array of strings) - Required - Names of the items in the invoice.
- **wsb_invoice_item_quantity** (array of integers) - Required - Quantities of the items.
- **wsb_invoice_item_price** (array of floats) - Required - Prices of the items.
- **wsb_total** (float) - Required - Total amount of the order.
- **wsb_customer_id** (string) - Optional - Customer identifier.
- **wsb_operation_type** (string) - Required - Type of operation, e.g., "recurring_bind".
- **wsb_signature** (string) - Required - Signature for request verification.
- **wsb_3ds_payment_option** (string) - Optional - 3D Secure payment option (e.g., "force_3ds").
- **wsb_store** (string) - Optional - Name of your store.
- **wsb_language_id** (string) - Optional - Language for the payment page (e.g., "russian").
- **wsb_redirect** (integer) - Optional - Redirect indicator (1 to enable).
- **wsb_return_format** (string) - Optional - Desired return format (e.g., "json").
- **wsb_return_url** (string) - Required - URL to redirect to after successful payment.
- **wsb_cancel_return_url** (string) - Required - URL to redirect to if payment is cancelled.
- **wsb_notify_url** (string) - Required - URL for server-to-server notifications.
- **wsb_customer_name** (string) - Optional - Full name of the customer.
- **wsb_customer_address** (string) - Optional - Customer's address.
- **wsb_service_date** (string) - Optional - Service or delivery date information.
- **wsb_tax** (float) - Optional - Tax amount.
- **wsb_shipping_name** (string) - Optional - Name of the shipping method.
- **wsb_shipping_price** (float) - Optional - Price of shipping.
- **wsb_discount_name** (string) - Optional - Name of the discount.
- **wsb_discount_price** (float) - Optional - Amount of the discount.
- **wsb_order_tag** (string) - Optional - An arbitrary tag for the order.
- **wsb_email** (string) - Optional - Customer's email address.
- **wsb_phone** (string) - Optional - Customer's phone number.
- **wsb_order_contract** (string) - Optional - Contract number related to the order.
- **wsb_tab** (string) - Optional - Specifies the payment tab to display (e.g., "cardPayment").
- **wsb_startsesstime** (string) - Optional - Timestamp for session start.
- **wsb_startsessdatetime** (string) - Optional - Datetime for session start.

### Request Example
```json
{
  "wsb_storeid": "11111111",
  "wsb_order_num": "ORDER-12345678",
  "wsb_currency_id": "BYN",
  "wsb_version": 2,
  "wsb_seed": "1242649174",
  "wsb_test": 1,
  "wsb_invoice_item_name": [
    "Товар 1",
    "Товар 2"
  ],
  "wsb_invoice_item_quantity": [
    2,
    1
  ],
  "wsb_invoice_item_price": [
    10,
    0.5
  ],
  "wsb_total": 31.4,
  "wsb_customer_id": "aA1217Zz",
  "wsb_operation_type": "recurring_bind",
  "wsb_signature": "ebefd130602a41f95238b5bd5cd1f3f803456093",
  "wsb_3ds_payment_option": "force_3ds",
  "wsb_store": "Название Вашего магазина",
  "wsb_language_id": "russian",
  "wsb_redirect": 1,
  "wsb_return_format ": "json",
  "wsb_return_url": "http://yoursiteurl.com/success.php",
  "wsb_cancel_return_url": "http://yoursiteurl.com/cancel.php",
  "wsb_notify_url": "http://yoursiteurl.com/notify.php",
  "wsb_customer_name": "Иванов Петр Петрович",
  "wsb_customer_address": "Минск ул. Шафарнянская д.11 оф.54",
  "wsb_service_date": "Доставка до 1 января 2022 года",
  "wsb_tax": 10.5,
  "wsb_shipping_name": "Стоимость доставки",
  "wsb_shipping_price": 0.98,
  "wsb_discount_name": "Скидка на товар",
  "wsb_discount_price": 0.58,
  "wsb_order_tag": "Договор №152/12-1 от 12.01.19",
  "wsb_email": "ivanov@test.by",
  "wsb_phone": "375291234567",
  "wsb_order_contract": "Договор №152/12-1 от 12.01.19",
  "wsb_tab": "cardPayment",
  "wsb_startsesstime": "1603383601",
  "wsb_startsessdatetime": "2020-10-22T16:20:01+03:00"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains transaction details.
  - **wt** (string) - Transaction token.
  - **redirectUrl** (string) - URL to redirect the user to complete the payment.

#### Response Example
```json
{
  "data": {
    "wt": "a8770d78a00802f78e002b36353a6130=63546473535746484d335a7652555a5a62316c434c3239525757637657565133646c637a63465a505455493256324a4856584e31556d6f79564663765a58686e55477330526d4e71644567334d565a4653545a7354672c2c",
    "redirectUrl": "https://securesandbox.webpay.by?wt=a8770d78a00802f78e002b36353a6130=63546473535746484d335a7652555a5a62316c434c3239525757637657565133646c637a63465a505455493256324a4856584e31556d6f79564663765a58686e55477330526d4e71644567334d565a4653545a7354672c2c"
  }
}
```

#### Error Response (400)
(Details for error responses are not provided in the source text.)
```

--------------------------------

### Recurring Payment Request

Source: https://docs.webpay.by/payment-json.html

Example of a request payload for a recurring payment operation.

```APIDOC
## POST /api/v1/payment

### Description
This endpoint is used to process a recurring payment using a previously stored token.

### Method
POST

### Endpoint
https://payment.webpay.by/api/v1/payment

### Parameters
#### Request Body
- **wsb_storeid** (number) - Required - Identifier for the store in the WEBPAY system.
- **wsb_order_num** (string) - Required - Unique order number.
- **wsb_currency_id** (string) - Required - Currency ID (e.g., BYN).
- **wsb_version** (number) - Required - Form version, defaults to 2.
- **wsb_seed** (string) - Required - Random sequence of characters for signature generation.
- **wsb_test** (number) - Optional - Test mode indicator (1 for test).
- **wsb_invoice_item_name** (array of strings) - Required - Names of invoice items.
- **wsb_invoice_item_quantity** (array of numbers) - Required - Quantities of invoice items.
- **wsb_invoice_item_price** (array of numbers) - Required - Prices of invoice items.
- **wsb_total** (number) - Required - Total amount of the order.
- **wsb_customer_id** (string) - Required - Unique customer identifier.
- **wsb_operation_type** (string) - Required - Operation type, e.g., "recurring_pay".
- **wsb_recurring_token** (string) - Required - Token for recurring payment.
- **wsb_signature** (string) - Required - Electronic signature of the order.
- **wsb_store** (string) - Optional - Name of the store.
- **wsb_language_id** (string) - Optional - Language ID (e.g., "russian").
- **wsb_redirect** (number) - Optional - Redirect indicator (1 to redirect).
- **wsb_return_format** (string) - Optional - Return format (e.g., "json").
- **wsb_return_url** (string) - Optional - URL to return to after successful payment.
- **wsb_cancel_return_url** (string) - Optional - URL to return to after canceling payment.
- **wsb_notify_url** (string) - Optional - URL for payment notifications.
- **wsb_customer_name** (string) - Optional - Customer's full name.
- **wsb_customer_address** (string) - Optional - Customer's address.
- **wsb_service_date** (string) - Optional - Service or delivery date.
- **wsb_tax** (number) - Optional - Tax amount.
- **wsb_shipping_name** (string) - Optional - Shipping method name.
- **wsb_shipping_price** (number) - Optional - Shipping cost.
- **wsb_discount_name** (string) - Optional - Discount name.
- **wsb_discount_price** (number) - Optional - Discount amount.
- **wsb_order_tag** (string) - Optional - Order tag or reference.
- **wsb_email** (string) - Optional - Customer's email address.
- **wsb_phone** (string) - Optional - Customer's phone number.
- **wsb_order_contract** (string) - Optional - Order contract details.
- **wsb_tab** (string) - Optional - Specifies the payment tab (e.g., "cardPayment").
- **wsb_startsesstime** (string) - Optional - Session start time (timestamp).
- **wsb_startsessdatetime** (string) - Optional - Session start date and time.

### Request Example
```json
{
  "wsb_storeid": "11111111",
  "wsb_order_num": "ORDER-12345678",
  "wsb_currency_id": "BYN",
  "wsb_version": 2,
  "wsb_seed": "1242649174",
  "wsb_test": 1,
  "wsb_invoice_item_name": [
    "Товар 1",
    "Товар 2"
  ],
  "wsb_invoice_item_quantity": [
    2,
    1
  ],
  "wsb_invoice_item_price": [
    10,
    0.5
  ],
  "wsb_total": 31.4,
  "wsb_customer_id": "aA1217Zz",
  "wsb_operation_type": "recurring_pay",
  "wsb_recurring_token": "834836387",
  "wsb_signature": "d1a5110dc27d38a5fed50f98def59029ed5e1564",
  "wsb_store": "Название Вашего магазина",
  "wsb_language_id": "russian",
  "wsb_redirect": 1,
  "wsb_return_format ": "json",
  "wsb_return_url": "http://yoursiteurl.com/success.php",
  "wsb_cancel_return_url": "http://yoursiteurl.com/cancel.php",
  "wsb_notify_url": "http://yoursiteurl.com/notify.php",
  "wsb_customer_name": "Иванов Петр Петрович",
  "wsb_customer_address": "Минск ул. Шафарнянская д.11 оф.54",
  "wsb_service_date": "Доставка до 1 января 2022 года",
  "wsb_tax": 10.5,
  "wsb_shipping_name": "Стоимость доставки",
  "wsb_shipping_price": 0.98,
  "wsb_discount_name": "Скидка на товар",
  "wsb_discount_price": 0.58,
  "wsb_order_tag": "Договор №152/12-1 от 12.01.19",
  "wsb_email": "ivanov@test.by",
  "wsb_phone": "375291234567",
  "wsb_order_contract": "Договор №152/12-1 от 12.01.19",
  "wsb_tab": "cardPayment",
  "wsb_startsesstime": "1603383601",
  "wsb_startsessdatetime": "2020-10-22T16:20:01+03:00"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains details of the successful payment.
  - **batch_timestamp** (string) - Timestamp of the batch.
  - **currency_id** (string) - Currency ID.
  - **amount** (string) - Transaction amount.
  - **customer_id** (string) - Customer ID.
  - **payment_method** (string) - Method used for payment.
  - **site_order_id** (string) - Original order ID.
  - **operation_type** (string) - Type of operation.
  - **order_id** (string) - WEBPAY order ID.
  - **terminal** (string) - Terminal ID.
  - **transaction_id** (string) - Transaction ID.
  - **recurring_token** (string) - Recurring token.
  - **payment_type** (number) - Type of payment.
  - **rrn** (string) - RRN of the transaction.
  - **rc** (string) - Response code.
  - **rc_text** (string) - Response code text.
  - **action** (number) - Action code.
  - **approval** (string) - Approval code.
  - **card** (string) - Masked card number.

#### Response Example
```json
{
  "data": {
    "batch_timestamp": "1622492694",
    "currency_id": "BYN",
    "amount": "31.4",
    "customer_id": "aA1217Zz",
    "payment_method": "cc",
    "site_order_id": "ORDER-12345678",
    "operation_type": "recurring_pay",
    "order_id": "307139115",
    "terminal": "99995551",
    "transaction_id": "834836387",
    "recurring_token": "834836387",
    "payment_type": 10,
    "rrn": "257885184293",
    "rc": "W0001(00)",
    "rc_text": "Successfully completed",
    "action": 0,
    "approval": "257885",
    "card": "434179xxxxxx0051"
  }
}
```

#### Error Response (400)
- **error** (object) - Contains error details.
  - **code** (string) - Error code.
  - **message** (string) - Error message.
```

--------------------------------

### POST /api/webpay/create_order (Simplified Payment)

Source: https://docs.webpay.by/payment-json.html

Creates a new order for a simplified payment and returns a redirect URL for the payment form.

```APIDOC
## POST /api/webpay/create_order

### Description
Request to get a link to the simplified payment form.

### Method
POST

### Endpoint
/api/webpay/create_order

### Parameters
#### Request Body
- **transaction_id** (string) - Required - Unique transaction identifier.
- **amount** (number) - Required - The amount of the payment.
- **currency** (string) - Required - The currency of the payment (e.g., 'BYN', 'USD').
- **description** (string) - Optional - Description of the payment.
- **wsb_return_url** (string) - Required - URL to return the client to after payment.
- **wsb_notify_url** (string) - Required - URL for the server-to-server notification.

### Request Example
```json
{
  "transaction_id": "67890def",
  "amount": 50.00,
  "currency": "BYN",
  "description": "Simplified payment for service",
  "wsb_return_url": "https://merchant.com/return",
  "wsb_notify_url": "https://merchant.com/notify"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('success' or 'error').
- **redirect_url** (string) - The URL to redirect the client to for payment.
- **transaction_id** (string) - The unique transaction identifier.

#### Response Example
```json
{
  "status": "success",
  "redirect_url": "https://webpay.by/payment?token=...",
  "transaction_id": "67890def"
}
```
```

--------------------------------

### GET /websites/webpay_by/cancel_return_url

Source: https://docs.webpay.by/payment-json.html

Handles the return of a payer to the merchant's site if payment is cancelled.

```APIDOC
## GET /websites/webpay_by/cancel_return_url

### Description
Handles the return of a payer to the merchant's site if payment is cancelled.

### Method
GET

### Endpoint
/websites/webpay_by/cancel_return_url

### Parameters
#### Query Parameters
- **transaction_id** (string) - Required - The transaction ID.
- **status** (string) - Required - The status, typically 'cancelled'.

### Response
#### Success Response (200)
- **message** (string) - A message indicating cancellation.

#### Response Example
```json
{
  "message": "Payment was cancelled. Please try again if needed."
}
```
```

--------------------------------

### POST /api/webpay/create_installment_payment

Source: https://docs.webpay.by/payment-json.html

Creates a payment for installment cards from 'Priorbank' OJSC and/or ZAO 'MTBank'.

```APIDOC
## POST /api/webpay/create_installment_payment

### Description
Creates a payment for installment cards from 'Priorbank' OJSC and/or ZAO 'MTBank'.

### Method
POST

### Endpoint
/api/webpay/create_installment_payment

### Parameters
#### Request Body
- **transaction_id** (string) - Required - Unique transaction identifier.
- **amount** (number) - Required - The amount of the payment.
- **currency** (string) - Required - The currency of the payment.
- **description** (string) - Optional - Description of the payment.
- **installments** (integer) - Required - The number of installments.
- **card_token** (string) - Required - Token representing the client's card.
- **wsb_return_url** (string) - Required - URL to return the client to after payment.
- **wsb_notify_url** (string) - Required - URL for the server-to-server notification.

### Request Example
```json
{
  "transaction_id": "installment_pbrf",
  "amount": 150.00,
  "currency": "BYN",
  "description": "Installment payment for electronics",
  "installments": 3,
  "card_token": "tok_aaaaaaaaaaaa",
  "wsb_return_url": "https://merchant.com/return",
  "wsb_notify_url": "https://merchant.com/notify"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request ('success' or 'error').
- **redirect_url** (string) - The URL to redirect the client to for payment.
- **transaction_id** (string) - The unique transaction identifier.

#### Response Example
```json
{
  "status": "success",
  "redirect_url": "https://webpay.by/payment?token=...",
  "transaction_id": "installment_pbrf"
}
```
```

--------------------------------

### POST /websites/webpay_by

Source: https://docs.webpay.by/payment-json.html

This endpoint is used to generate a redirect URL for the Webpay payment form. It requires a comprehensive set of parameters to define the transaction details, including store information, order specifics, currency, payment version, security credentials, item details, total amount, and signature. Optional parameters allow for setting due dates, store names, language, and various return/notification URLs.

```APIDOC
## POST /websites/webpay_by

### Description
Generates a redirect URL for the Webpay payment form.

### Method
POST

### Endpoint
/websites/webpay_by

### Parameters
#### Request Body
- **wsb_storeid** (number) - Required - Identifier of the store in the WEBPAY system.
- **wsb_order_num** (string) - Required - Unique identifier of the order assigned by the store. Cannot start with '0' if using ERIF.
- **wsb_currency_id** (string) - Required - Currency identifier (ISO 4271). Enum: "BYN", "USD", "EUR", "RUB".
- **wsb_version** (number) - Optional - Payment form version. Defaults to 2.
- **wsb_seed** (string) - Required - Random sequence of characters for generating the order's electronic signature.
- **wsb_test** (number) - Optional - Indicates a test payment. 1 for test, 0 for real payment. Defaults to 0.
- **wsb_invoice_item_name** (array<string>) - Required - Name of the item.
- **wsb_invoice_item_quantity** (array<integer>) - Required - Quantity of the item.
- **wsb_invoice_item_price** (array<float>) - Required - Price per unit of the item. Format: ^\d+[.,]?\d{0,2}$
- **wsb_total** (number) - Required - Total payment amount for the order. Calculated as: sum(quantity * price) + tax + shipping - discount. Must match the calculated value.
- **wsb_signature** (string) - Required - Order control value (electronic signature) generated using SHA1 (for version 2) or MD5. Formed by concatenating specific fields and a secret key.
- **wsb_due_date** (number) - Optional - Timestamp until which the invoice is available for payment.
- **wsb_store** (string) - Optional - Name of the store displayed on the payment form. Defaults to the billing account setting.
- **wsb_language_id** (string) - Optional - Language identifier for the payment form. Enum: "russian", "english". Defaults to browser/system settings.
- **wsb_redirect** (integer) - Optional - Redirects the payer immediately after payment without displaying the WEBPAY payment page. Value: 1.
- **wsb_return_format** (string) - Optional - Format of the response to the store after redirect. Value: "json".
- **wsb_return_url** (string) - Optional - URL to which the customer is redirected upon successful payment. Order ID and transaction number are appended.
- **wsb_cancel_return_url** (string) - Optional - URL to which the customer is redirected upon unsuccessful payment. Order ID is appended.
- **wsb_notify_url** (string) - Optional - URL called regardless of redirect success to notify the site about successful payment. Must use standard ports (80, 443, 8080, 8443).

### Request Example
```json
{
  "wsb_storeid": 12345,
  "wsb_order_num": "ORDER789",
  "wsb_currency_id": "BYN",
  "wsb_version": 2,
  "wsb_seed": "random_seed_string",
  "wsb_test": 0,
  "wsb_invoice_item_name": ["Product A", "Service B"],
  "wsb_invoice_item_quantity": [1, 2],
  "wsb_invoice_item_price": [10.50, 5.00],
  "wsb_total": 20.50,
  "wsb_signature": "generated_signature_hash",
  "wsb_return_url": "https://yourstore.com/payment/success",
  "wsb_cancel_return_url": "https://yourstore.com/payment/cancel",
  "wsb_notify_url": "https://yourstore.com/payment/notify"
}
```

### Response
#### Success Response (200)
- **redirectUrl** (string) - The URL to which the user should be redirected to complete the payment.

#### Response Example
```json
{
  "redirectUrl": "https://pay.webpay.by/form?param1=value1&param2=value2..."
}
```
```
Tokens:
Raw