Apple Pay - Freedom Pay

Request

Body Params multipart/form-data

pg_amount

number

required

Payment amount.||number

Example:

10

pg_currency

string

required

Payment/transfer currency
In Kazakhstan only KZT is allowed

Example:

KZT

pg_description

string

required

Payment description.
Letters, numbers, dash (-), space

Example:

Описание платежа

pg_merchant_id

number

required

Merchant ID
Numbers.||integer

Example:

pg_order_id

string

required

Order ID in the shop system
Numbers and Latin characters

Example:

123

pg_card_name

string

required

Name and surname of card holders. Letters (Latin), dash (-) and space

Example:

TEST TESTOV

pg_card_pan

string

required

Card number
Number of digits: from 13 to 20.||integer

pg_card_cvc

integer

optional

CVC/CVC2/CVV card password Numbers.||integer

pg_card_year

integer

required

Card expiration year
Number of digits: 2||integer

pg_card_month

integer

required

Card expiration month
Number of digits: 2||integer

pg_auto_clearing

boolean

required

Clearing type (0 or 1).
1 - automatic write-off after successful authorization, 0 - write-off by launching the clearing method Number of digits: 1||integer

pg_testing_mode

integer

required

Payment mode.
0 - production, 1 - test. If the mode is not specified, then the mode set in the shop settings is taken||integer

pg_3ds_challenge

boolean

required

Determines the need to complete the Challenge Flow
(1 - it is mandatory to conduct the Challenge Requested, 0 or empty - the method is determined by the issuer) the issuing bank can ignore this parameter and make a payment according to its own Challenge Flow

pg_param1

string

required

Additional parameter 1
String

pg_param2

string

required

Additional parameter 2
String

pg_param3

string

required

Additional parameter 3
String

pg_sig

string

required

Digital signature of the request.
Numbers and Latin letters

Example:

pg_salt

string

required

Random string.
Random numbers and Latin letters Example: some random string

Example:

some random string

pg_online_payment_cryptogram

string

required

Ephemeral public key bytes. EC_v1 only. Encrypted string. Related to the field pg_eci_indicator

pg_eci_indicator

string

optional

Optional. ECI indicator, as definition of 3d secure. Confirmation from Apple
String. Related to the field pg_online_payment_cryptogram

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/g2g/payment' \
--form 'pg_amount="10"' \
--form 'pg_currency="KZT"' \
--form 'pg_description="Описание платежа"' \
--form 'pg_merchant_id="{{paybox_merchant_id}}"' \
--form 'pg_order_id="123"' \
--form 'pg_card_name="TEST TESTOV"' \
--form 'pg_card_pan=""' \
--form 'pg_card_cvc=""' \
--form 'pg_card_year=""' \
--form 'pg_card_month=""' \
--form 'pg_auto_clearing=""' \
--form 'pg_testing_mode=""' \
--form 'pg_3ds_challenge=""' \
--form 'pg_param1=""' \
--form 'pg_param2=""' \
--form 'pg_param3=""' \
--form 'pg_sig="{{paybox_signature}}"' \
--form 'pg_salt="some random string"' \
--form 'pg_online_payment_cryptogram=""' \
--form 'pg_eci_indicator=""'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

Payment ID

pg_status

string

required

ok

pg_3ds

boolean

required

pg_3d_acsurl

string

required

pg_3d_md

string

required

pg_3d_pareq

string

required

pg_recurring_profile

integer

required

pg_card_id

string

required

pg_card_token

string

required

pg_auth_code

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>1234567890</pg_payment_id>
    <pg_status>ok</pg_status>
    <pg_3ds>1</pg_3ds>
    <pg_3d_acsurl>https://bank.com/3ds-validation</pg_3d_acsurl>
    <pg_3d_md>abc123456</pg_3d_md>
    <pg_3d_pareq>xyz-98765</pg_3d_pareq>
    <pg_recurring_profile>12345</pg_recurring_profile>
    <pg_card_id>9876543210</pg_card_id>
    <pg_card_token>token-abc123</pg_card_token>
    <pg_auth_code>123456</pg_auth_code>
    <pg_salt>some random string</pg_salt>
    <pg_sig>signature-abc123</pg_sig>
    <pg_datetime>2024-09-02T12:19:01+00:00</pg_datetime>
</response>