IBAN

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_amount

number

required

Transfer amount. Minimum 0.01.

>= 0.01<= 99999999

pg_order_id

string

required

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

Example:

550e8400-e29b-41d4-a716-446655440000

pg_description

string

optional

Payment description

<= 255 characters

pg_recipient_iban

string

required

IBAN account number

>= 20 characters<= 20 characters

Example:

KZ123412341234123412

pg_recipient_iin

number

required

Recipient IIN

Example:

761223455678

pg_recipient_name

string

required

Recipient name

Example:

IVANOV IVAN

pg_recipient_kbe

integer

required

Recipient kbe

Example:

19

pg_knp

integer

required

Receiver's KNP

Example:

119

pg_bank_bik

string

required

Receiver's BIC

<= 8 characters

Example:

KZZSAE

pg_post_link

string

required

URL to which payment status response is sent

<= 255 characters

Example:

http://site.com/post

pg_salt

string

required

A random string consisting of arbitrary numbers and Latin letters

pg_sig

string

required

Request signature

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/api/to_iban' \
--form 'pg_merchant_id=""' \
--form 'pg_amount=""' \
--form 'pg_order_id="550e8400-e29b-41d4-a716-446655440000"' \
--form 'pg_description=""' \
--form 'pg_recipient_iban="KZ123412341234123412"' \
--form 'pg_recipient_iin="761223455678"' \
--form 'pg_recipient_name="IVANOV IVAN"' \
--form 'pg_recipient_kbe="19"' \
--form 'pg_knp="119"' \
--form 'pg_bank_bik="KZZSAE"' \
--form 'pg_post_link="http://site.com/post"' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

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

pg_merchant_id

integer

required

Merchant ID in the {{project}} system.

pg_status

string

required

Request Status.

pg_order_id

string

required

Order ID in the merchant system.

pg_payment_amount

number

required

Payment amount.

pg_payment_date

string <date-time>

required

Date and time of the payment.

pg_salt

string

required

Random string consisting of arbitrary numbers and Latin letters.

pg_sig

string

required

Request signature.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pg_payment_id>0</pg_payment_id>
  <pg_merchant_id>0</pg_merchant_id>
  <pg_status>string</pg_status>
  <pg_order_id>string</pg_order_id>
  <pg_payment_amount>0</pg_payment_amount>
  <pg_payment_date>2019-08-24T14:15:22Z</pg_payment_date>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>

Interaction diagram#

Request

Request samples

Responses

Interaction diagram