Non-acceptance payments (Pay)

POST

https://api.freedompay.kz/v1/merchant/{{paybox_merchant_id}}/card/direct

This method is the actual non-acceptance payment using the token, based on the previously created payment_id obtained in the previous step (Init)

Interaction diagram

Status: success/error/pending

Merchant_API_V3-Non-acceptance payments.drawio.png

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_payment_id

integer

required

Transaction ID

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api.freedompay.kz/v1/merchant/{{paybox_merchant_id}}/card/direct' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_id=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

pg_status

string

required

Shows the result of the query
Status Description
ok — Request was successful,
error — Request was successful

pg_payment_id

integer

required

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

pg_merchant_id

integer

required

Merchant ID in the system {{project}}

pg_order_id

string

required

Order ID in the merchant system

pg_salt

string

required

Random string.

pg_sig

string

required

Request signature.

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>7999007883</pg_payment_id>
    <pg_can_reject>1</pg_can_reject>
    <pg_payment_method>bankcard</pg_payment_method>
    <pg_amount>100</pg_amount>
    <pg_currency>KZT</pg_currency>
    <pg_transaction_status>ok</pg_transaction_status>
    <pg_captured>1</pg_captured>
    <pg_card_pan>4111-11XX-XXXX-1111</pg_card_pan>
    <pg_card_id>56</pg_card_id>
    <pg_card_token>541c0533-a131-48fa-909c-dd0662aea3bc</pg_card_token>
    <pg_auth_code>487129</pg_auth_code>
    <pg_create_date>2024-11-19 11:40:49</pg_create_date>
    <pg_salt>X0yt6VlmpbACmjlt</pg_salt>
    <pg_sig>b714dcd1cd0c3c2b482a6d87c46fac2b</pg_sig>
</response>

🟢200Error

🟢200Invalid Signature

Modified at 2025-03-24 15:41:48

Non-acceptance payments

Token payout

Non-acceptance payments (Pay)

Interaction diagram#

Request

Request samples

Responses

Interaction diagram