List

Request

Path Params

paybox_merchant_id

string

required

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_user_id

string

required

User ID in the merchant system

<= 50 characters

Example:

No65GFR755789T

Match pattern:

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

pg_extend_data

enum<integer>

optional

For obtaining additional card details, namely:
1 . Card brand (brand_alias)
2 . Card expiration date (expiry_year and expiry_month)
3 . Bank alias of the card (bank_alias)
To receive this information, you need to send 1.

Allowed values:

01

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.kz/v1/merchant//cardstorage/list' \
--form 'pg_merchant_id=""' \
--form 'pg_user_id="No65GFR755789T"' \
--form 'pg_extend_data=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

card

object

required

Card details.

pg_status

string

optional

Shows the status of the card.

pg_merchant_id

integer

optional

Merchant ID in the system {{project}}.

pg_card_id

integer

optional

Card ID (Deprecated).

pg_card_token

string

optional

Card token.

pg_card_hash

string

optional

Masked PAN card.

pg_card_hhash

string

optional

Hash of the masked PAN card.

pg_recurring_profile_id

string

optional

Recurring payment profile ID.

created_at

string <date-time>

optional

Date when the card was added.

bank_alias

string

optional

Bank alias of the card. Available if pg_extend_data=1.

brand_alias

string

optional

Card brand. Available if pg_extend_data=1.

expiry_year

string

optional

Card expiration year. Available if pg_extend_data=1.

expiry_month

string

optional

Card expiration month. Available if pg_extend_data=1.

pg_sig

string

required

Request signature.

pg_salt

string

required

Random string.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <card>
    <pg_status>string</pg_status>
    <pg_merchant_id>0</pg_merchant_id>
    <pg_card_id>0</pg_card_id>
    <pg_card_token>string</pg_card_token>
    <pg_card_hash>string</pg_card_hash>
    <pg_card_hhash>string</pg_card_hhash>
    <pg_recurring_profile_id>string</pg_recurring_profile_id>
    <created_at>2019-08-24T14:15:22Z</created_at>
    <bank_alias>string</bank_alias>
    <brand_alias>string</brand_alias>
    <expiry_year>string</expiry_year>
    <expiry_month>string</expiry_month>
  </card>
  <pg_sig>string</pg_sig>
  <pg_salt>string</pg_salt>
</root>

Interaction diagram#

Request

Request samples

Responses

Interaction diagram