Freedom Pay

Add

POST

https://api.freedompay.kz/v1/merchant/{{paybox_merchant_id}}/cardstorage/add

This method is used to add the card to cardstorage

Interaction diagram

Status: success/error/pending

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_order_id

string

optional

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

Example:

550e8400-e29b-41d4-a716-446655440000

pg_user_id

string

required

User ID in the merchant system

<= 50 characters

Example:

No65GFR755789T

Match pattern:

^[a-zA-Z0-9_-]+$

pg_back_link

string <email>

required

URL to which the user is redirected in case of successful payment

<= 255 characters

Example:

https://site.com/back

pg_post_link

string <email>

optional

URL to which payment status response is sent

<= 255 characters

Example:

https://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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api.freedompay.kz/v1/merchant/{{paybox_merchant_id}}/cardstorage/add' \
--form 'pg_merchant_id=""' \
--form 'pg_order_id="550e8400-e29b-41d4-a716-446655440000"' \
--form 'pg_user_id="No65GFR755789T"' \
--form 'pg_back_link="https://site.com/back"' \
--form 'pg_post_link="https://site.com/post";type=* URL to post the result.' \
--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 system {{project}}.

pg_order_id

string

required

Order ID in the merchant system.

pg_status

string

required

Shows the result of the query.

pg_redirect_url

string

required

URL to call in iframe or redirect (redirect).

pg_type

string

required

Transaction type.

pg_salt

string

required

Random string.

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_order_id>string</pg_order_id>
  <pg_status>string</pg_status>
  <pg_redirect_url>string</pg_redirect_url>
  <pg_type>string</pg_type>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>

Modified at 2025-03-24 15:19:31

Overview

Add for payout

Add

Interaction diagram#

Request

Request samples

Responses

Interaction diagram