Paritetbank online credit

This method is used to pay for an item using Paritetbank online credit.

Credit application flow 1: The merchant selects the credit option prior to sending the credit application to the bank.

Stage	Description
1	The customer selects an item on the merchant's website and then selects an option to pay for it using Paritetbank credit.
2	The merchant displays the available credit options to the customer.
3	The customer selects the credit option.
4	The merchant sends a payment request to bePaid specifying the identifier of the selected credit option. `method.type` value must be `paritetbank_credit` or `paritetbank_installment`.
5	The customer is redirected to the bank page to confirm their order.
6	The customer is redirected to the Interbank System of Identification website for authentication.
7	The customer is redirected to Paritetbank website where they complete the credit application.
8	The merchant receives a notification about the status of the credit application. As a rule, the decision is made within 15 minutes. The money is credited to the merchant's account the next banking day following the day when the credit application was confirmed. The maximum length of the confirmation period is 30 days.

Credit application flow 2: The merchant doesn't select the credit option prior to sending the credit application to the bank.

Stage	Description
1	The customer selects an item on the merchant's website and then selects an option to pay for it using Paritetbank credit.
2	The merchant sends a payment request to bePaid.`method.type` value must be `paritetbank_loans`.
3	The customer is redirected to the bank page to confirm their order.
4	The customer is redirected to the Interbank System of Identification website for authentication.
5	The customer is redirected to Paritetbank website where they select a credit option from the list of the suggested credit options and complete the credit application.
6	The merchant receives a notification about the status of the credit application. As a rule, the decision is made within 15 minutes. The money is credited to the merchant's account the next banking day following the day when the credit application was confirmed. The maximum length of the confirmation period is 30 days.

Payment

Request

Parameters of the payment widget and the payment token

In the case of the integration with the payment widget or the payment page, initiate the widget or create a payment token with the additional optional object order.additional_data.cart with information on the items.

Payment request parameters

Send a payment request with the following data:

Parameter	Type	Description
request	object
return_url * required	string	URL to return the customer to when the transaction is completed.
method	object	A section of the payment method information.
type * required	string	`paritetbank_credit` or `paritetbank_installment` for an installment plan or `paritetbank_loans`.
channel * required	string	Identifier of the selected credit option. For `paritetbank_loans` the identifier of the base credit option must be submitted. The list of the credit identifiers can be requested from your manager.
customer	object	A section of the customer details.
phone	string	The customer's phone number.
additional_data	object	A section of additional transaction parameters.
cart	object	A section with information on the items added to cart by the customer and to be paid for using Paritetbank credit.
positions * conditionally required	array	An array of objects where each object corresponds to an item to be paid for using Paritetbank credit. Required if `cart` object is sent. Each object includes the following parameters.
name * conditionally required	string	The name of the item. Required if the `positions` parameter is sent.
type	string	Type of the item.
amount * conditionally required	integer	The price of the item in minimal currency units. The sum of the amount values for all items must equal the transaction amount. Required if the `positions` parameter is sent.
quantity * conditionally required	integer	The number of the identical items. Required if the `positions` parameter is sent.
description * conditionally required	string	Description of the item.
nomenclature_code * conditionally required	string	Nomenclature code of the item. Required if the `positions` parameter is sent.

Request example

{
  "request": {
    "amount": 20000,
    "currency": "BYN",
    "description": "description",
    "test": false,
    "return_url": "https://your_return_url.com",
    "notification_url": "https://your_notification_url.com",
    "method": {
      "type": "paritetbank_credit",
      "channel": "6925e85e-eec4-410a-bc88-0a5f73030f76"
    },
    "customer": {
      "phone": "12341345134"
    },
    "additional_data": {
      "cart": {
        "positions": [
          {
            "description": "description",
            "nomenclature_code": "code",
            "amount": 20000,
            "name": "book",
            "quantity": 1
          }
        ]
      }
    }
  }
}

Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example

{
  "transaction": {
    "uid": "6191805f-171d-4167-a142-680a7e8626ac",
    "type": "payment",
    "status": "pending",
    "amount": 20000,
    "currency": "BYN",
    "description": "description",
    "created_at": "2024-06-20T06:40:22Z",
    "updated_at": "2024-06-20T06:40:22Z",
    "method_type": "paritetbank_credit",
    "receipt_url": "https://merchant.bepaid.by/customer/transactions/6191805f-171d-4167-a142-680a7e8626ac/722448eb404e195ee80262242a200171e99c7ac922fcc04f90c95675980007c4",
    "payment": {
      "status": "pending",
      "gateway_id": 4065,
      "message": "Transaction was initialized.",
      "bank_code": "c8e26987-ee62-407c-91b3-f2ccbe0f82bb"
    },
    "paritetbank_credit": {
      "type": "paritetbank_credit"
    },
    "customer": {
      "phone": "12341345134",
      "email": null,
      "ip": null
    },
    "manually_corrected_at": null,
    "message": "Transaction was initialized.",
    "test": false,
    "billing_address": {
      "phone": "12341345134"
    },
    "additional_data": {
      "cart": {
        "positions": [
          {
            "description": "description",
            "nomenclature_code": "code",
            "amount": 20000,
            "name": "book",
            "quantity": 1
          }
        ]
      },
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": true
    },
    "form": {
      "action": "redirect-link",
      "method": "GET",
      "fields": []
    }
  }
}