Init

To use this method, you need to initiate the payment by sending a request to the Freedom Pay Gateway.
In response, you will receive an invoice_id and a QR (URL to redirect the user in the form of a QR code).

Interaction diagram

Status: success/error/pending

Request

Body Params multipart/form-data

order_id

string

required

Payment ID in the merchant system. It is recommended to keep this field unique.

<= 50 characters

Example:

550e8400-e29b-41d4-a716-446655440000

merchant_id

integer

required

Merchant ID in {{project}} issued upon connection.

amount

number <float>

required

Payment amount in currency.

>= 0.01<= 99999999

description

string

required

Description of the product or service. Displayed to the buyer during the payment process.

<= 255 characters

invoice_method

string

required

Invoicing method. Values are separated by commas. Possible values: qr.

<= 255 characters

currency

string

optional

The currency in which the amount is indicated. KZT

check_url

string

optional

URL to check the possibility of payment. Called before the payment

<= 255 characters

Example:

https://site.com/check

result_url

string

optional

URL for reporting the result of the payment. Called after payment on success or failure. Required if not set in the store settings.

<= 255 characters

Example:

https://site.com/result

request_method

enum<string>

optional

GET

Allowed values:

GETPOST

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/xml

Body

status

string

required

Shows the result of the query.

Status Description:

ok: Request was successful.

error: Request failed.

invoice_status

string

required

Invoice status.

Status Description:

new: New invoice.

process: Waiting for the payer or payment system.

ok: Invoice paid successfully.

failed: Invoice payment error.

incomplete: Invoice expired.

error_code

integer

optional

Error code ID.

error_description

string

optional

Text description of the error.

invoice_id

integer

required

The unique identifier of the payment transaction in {{project}} serves as the key for all further work with the transaction.

invoice_methods

object

optional

The object contains the billing methods requested by the merchant.

string

optional

URL to redirect the user in the form of a QR. Passed in base64 format.

Example URL: https://customer.freedompay.kz/pay.html?customer=kzobd2vgp17214143761774775392946

string <date-time>

required

Date and time of the request. Format: YYYY-MM-DDThh:mm:ss±hh:mm.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <status>string</status>
  <invoice_status>string</invoice_status>
  <error_code>0</error_code>
  <error_description>string</error_description>
  <invoice_id>0</invoice_id>
  <invoice_methods>
    <qr>string</qr>
  </invoice_methods>
  <dt>2019-08-24T14:15:22Z</dt>
</root>

Interaction diagram#

Request

Request samples

Responses

Interaction diagram