Init - Freedom Pay

Request

Body Params multipart/form-data

order_id

string

required

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

Example:

00102

merchant_id

integer

required

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

amount

number

required

Payment amount in currency.

Example:

10

description

string

required

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

Example:

Ticket

invoice_method

string

required

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

Example:

qr

currency

string

optional

The currency in which the amount is indicated. KZT

Example:

KZT

check_url

string

optional

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

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.

request_method

string

optional

GET

Example:

POST

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.uz/v5/merchant/invoice/init' \
--form 'order_id="00102"' \
--form 'merchant_id=""' \
--form 'amount="10"' \
--form 'description="Ticket"' \
--form 'invoice_method="qr"' \
--form 'currency="KZT"' \
--form 'check_url=""' \
--form 'result_url=""' \
--form 'request_method="POST"'

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.

qr

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

dt

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>