IBAN

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

Example:

pg_order_id

integer

required

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

pg_amount

number

required

Payment amount

>= 0.01

pg_description

string

optional

Payment description

pg_recipient_iban

string

required

IBAN account number

pg_recipient_iin

string

required

Recipient IIN

pg_recipient_name

string

required

Recipient name

pg_recipient_kbe

integer

required

Recipient kbe

pg_knp

integer

required

Receiver's KNP

pg_bank_bik

string

required

Receiver's BIC

pg_post_link

string

required

URL to which payment status response is sent

pg_salt

string

required

A random string consisting of arbitrary numbers and Latin letters

pg_sig

string

required

Request signature

Example:

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/g2g/to_iban' \
--form 'pg_merchant_id="{{paybox_merchant_id}}"' \
--form 'pg_order_id=""' \
--form 'pg_amount=""' \
--form 'pg_description=""' \
--form 'pg_recipient_iban=""' \
--form 'pg_recipient_iin=""' \
--form 'pg_recipient_name=""' \
--form 'pg_recipient_kbe=""' \
--form 'pg_knp=""' \
--form 'pg_bank_bik=""' \
--form 'pg_post_link=""' \
--form 'pg_salt=""' \
--form 'pg_sig="{{paybox_signature}}"'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

pg_merchant_id

integer

required

pg_status

string

required

pg_order_id

string

required

pg_payment_amount

number

required

pg_payment_date

string

required

pg_salt

string

required

pg_sig

string

required

pg_datetime

string

required

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>7777777777</pg_payment_id>
    <pg_merchant_id>9970</pg_merchant_id>
    <pg_status>ok</pg_status>
    <pg_order_id>ORD12345</pg_order_id>
    <pg_payment_amount>1000</pg_payment_amount>
    <pg_payment_date>2024-09-02T12:19:01+00:00</pg_payment_date>
    <pg_salt>YtfwCGiBHsFLpYGk</pg_salt>
    <pg_sig>ccee466c01c2332d8a065d6108fd686b</pg_sig>
    <pg_datetime>2024-09-02T12:19:01+00:00</pg_datetime>
</response>

🟢200Error

🟢200Invalid Signature

Interaction diagram#

Request

Request samples

Responses

Interaction diagram