Title | Description | Type | |
---|---|---|---|
pg_merchant_id required | Merchant ID Numbers | integer | |
pg_order_id required | Order ID in the shop system. A unique, monotonically increasing value is recommended Example: 00102 | string | |
pg_amount required | Installment/loan amount. Minimum 0.01 Example: 10000 | number | |
pg_description required | ОPayment description. Displayed to the buyer during the payment process. | string | |
pg_salt required | Random string Random numbers and Latin letters Example: some random string | string | |
pg_sig required | Digital signature of the request | string |
Title | Description | Type | |
---|---|---|---|
pg_payment_id | The unique identifier of the payment transaction in FreedomPay, which serves as the key for all further work with the transaction | integer | |
pg_merchant_id | Merchant ID | string | |
pg_order_id | Order ID in the shop system. | string | |
pg_amount | Installment/loan amount | number | |
pg_redirect_url | The URL to which you want to redirect (redirect) | string | |
pg_type | Transaction type | string | |
pg_salt | Random string | string | |
pg_sig | Digital signature of the request | string |
curl --location --request POST 'https://api.freedompay.kz/v1/merchant/{{paybox_merchant_id}}/installment/init' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'pg_merchant_id={{paybox_merchant_id}}' \
--form 'pg_order_id=12345' \
--form 'pg_amount=10000' \
--form 'pg_description=test' \
--form 'pg_salt=some random string' \
--form 'pg_sig={{paybox_signature}}'
# Signature example:
'init;10000;test;{{paybox_merchant_id}};12345;some random string;{{secret_key}}'
<?xml version="1.0" encoding="utf-8"?>
<response>
<pg_payment_id>831338051</pg_payment_id>
<pg_merchant_id>545084</pg_merchant_id>
<pg_order_id>00004</pg_order_id>
<pg_amount>10000</pg_amount>
<pg_redirect_url>https://customer.freedompay.kz/pay.html?customer=your_customer_value</pg_redirect_url>
<pg_status>ok</pg_status>
<pg_type>init</pg_type>
<pg_salt>salt</pg_salt>
<pg_sig>sig</pg_sig>
</response>
Name | Description | Type | |
---|---|---|---|
pg_merchant_id required | Merchant ID in FreedomPay. Issued upon connection. | integer | |
pg_payment_id required if empty pg_order_id | Internal payment identifier in the system FreedomPay if sent along with the pg_order_id field, the pg_order_id field will be ignored. Example: 12345 | integer | |
pg_order_id required if empty pg_payment_id | Payment ID in the merchant system. Be careful, when requesting by order_id, the merchant must independently monitor the uniqueness of this parameter, otherwise information will be returned for the last payment with the given order_id for this merchant. Example: 00102 | string | |
pg_salt required | Random string Example: some random string | string | |
pg_sig required | Request signature | string |
Title | Description | Type | |
---|---|---|---|
pg_status | Shows the result of the query Status Description ok Request was successful error Request was successful | string | |
pg_payment_id | Unique identifier of the payment transaction in FreedomPay Serves as a key for all further work with the transaction | integer | |
pg_can_reject | 0 or 1 - whether the payment can be cancelled. The value 1 is possible only if the payment status is ok and the payment system provides the possibility to cancel the payment. In this case, the merchant can call revoke.php. | bool | |
pg_payment_method | Value - Payment method mobile_commerce - Mobile commerce Example: mobile_commerce | string | |
pg_order_id | Order ID in the shop system | string | |
pg_currency | The currency in which the amount is specified. | string | |
pg_payment_status | Payment status | string | |
pg_amount | Payment amount | integer | |
pg_clearing_amount | Amount written off during payment clearing | integer | |
pg_revoke_amount | Revoked amount | integer | |
pg_user_email | Customer's email | string | |
pg_card_name | Cardholder name | string | |
pg_user_phone | Customer's phone | string | |
pg_payment_date | Date and time of the payment in YYYY-MM-DD HH:MM:SS format | datetime | |
pg_revoked_payments | List of revokes for this payment | array | |
pg_refund_payments | List of refunds for this payment | array | |
pg_reference | A unique bank transaction identifier assigned by the bank (RRN) | integer | |
pg_failure_code | Error code | integer | |
pg_failure_description | Description of the error | string | |
pg_captured | Enum:0 1. Transmitted only in case of successful payment with a bank card and indicates whether clearing was performed at the time of authorization (which depends only on the merchant settings). If the value of this field is equal to 0, the merchant must subsequently issue a clearing command or wait for FreedomPay to do it himself | bool | |
pg_auth_code | Bank payment authorization code | integer | |
pg_salt | Random string | string | |
pg_sig | Request signature | string |
Title | Description | Type | |
---|---|---|---|
pg_payment_id | Unique identifier of the payment transaction in FreedomPay | integer | |
pg_payment_status | Payment status | string | |
pg_amount | Payment amount | integer | |
pg_payment_date | Date and time of the payment in YYYY-MM-DD HH:MM:SS format | datetime | |
pg_reference | A unique bank transaction identifier assigned by the bank (RRN) | integer |