Apple Pay - Freedom Pay

Request

Body Params multipart/form-data

pg_merchant_id

number

required

Merchant ID in {{project}}
Issued upon connection

pg_order_id

string

required

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

pg_amount

number

required

Payment amount in pg_currency

pg_currency

string

required

Currency in which the amount is specified

pg_description

string

required

Payment description
(These parameters may include parameters from other sections. For the effective operation of SecureBox, it is recommended to follow the validation guidelines and field examples from this section)

pg_testing_mode

integer

required

Creating a payment in test mode

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

pg_payment_method

string

required

Payment method

pg_card_pan

string

required

Card number

pg_card_cvc

integer

optional

CVC/CVC2/CVV card password

pg_card_year

integer

required

Card expiration year

pg_card_month

integer

required

Card expiration month

pg_card_name

string

required

Name and surname of card holders

pg_online_payment_cryptogram

string

required

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

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_eci_indicator

string

required

ECI indicator, as definition of 3d secure. Confirmation from Apple
String

pg_param1

string

required

Additional parameter 1

pg_param2

string

required

Additional parameter 2

pg_param3

string

required

Additional parameter 3

pg_salt

string

required

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/g2g/payment' \
--form 'pg_merchant_id=""' \
--form 'pg_order_id=""' \
--form 'pg_amount=""' \
--form 'pg_currency=""' \
--form 'pg_description=""' \
--form 'pg_testing_mode=""' \
--form 'pg_auto_clearing=""' \
--form 'pg_payment_method=""' \
--form 'pg_card_pan=""' \
--form 'pg_card_cvc=""' \
--form 'pg_card_year=""' \
--form 'pg_card_month=""' \
--form 'pg_card_name=""' \
--form 'pg_online_payment_cryptogram=""' \
--form 'pg_3ds_challenge=""' \
--form 'pg_eci_indicator=""' \
--form 'pg_param1=""' \
--form 'pg_param2=""' \
--form 'pg_param3=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

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>