Pay - Freedom Pay

Request

Body Params multipart/form-data

customer

string

required

This parameter is displayed in the response to invoice/init - invoice_methods.qr.

Example:

kzobd2vgp17214143761774775392946

user_id

string

required

User ID in the merchant system.

Example:

No65GFR755789T25642588

card_token

string

required

Card token for payment with a saved card.

Example:

ef741cfc-f85e-41a0-84e6-2ba964912182

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.kz/v5/merchant/invoice/pay' \
--form 'customer="kzobd2vgp17214143761774775392946"' \
--form 'user_id="No65GFR755789T25642588"' \
--form 'card_token="ef741cfc-f85e-41a0-84e6-2ba964912182"'

Responses

🟢200Success

application/xml

Body

status

string

required

Shows the result of the query.

Status Description:

ok: Request was successful.

error: Request failed.

order_id

string

required

Invoice identifier in the merchant system.

Example: 00102

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.

invoice_id

integer

optional

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

Displayed only on invoice_status - ok, failed.

error_code

integer

optional

Error code ID.

error_description

string

optional

Text description of the error.

card_pan

string

optional

Masked card number (part of the digits of the card number are hidden).

Example: 5483-18XX-XXXX-0293

Displayed only on invoice_status - ok, failed.

amount

number

required

Invoice amount.

currency

string

required

The currency in which the amount is indicated.

Example: KZT

Displayed only on invoice_status - ok, failed.

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>
  <order_id>string</order_id>
  <invoice_status>string</invoice_status>
  <invoice_id>0</invoice_id>
  <error_code>0</error_code>
  <error_description>string</error_description>
  <card_pan>string</card_pan>
  <amount>0</amount>
  <currency>string</currency>
  <dt>2019-08-24T14:15:22Z</dt>
</root>