Freedom Pay
  1. Card
Freedom Pay
  • Gateway API
    • Introduction
    • Reference
      • Test cards
      • Error codes
    • Sync API
      • Introduction
      • Page
        • Introduction
        • Page
        • Page with amount control
        • Status
      • Pay
        • Introduction
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Introduction
        • Card
        • IBAN
        • Balance
        • Status
        • StatusV2
      • Transfer
        • Introduction
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Introduction
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Introduction
        • Token Pay
        • Apple Pay
        • Google Pay
        • Samsung Pay
        • Token Payout
        • Status
    • Async API
      • Introduction
      • create
        • create payment
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • Merchant API
    • Introduction
    • Reference
      • Test cards
      • Test phone numbers
      • Error codes
    • Page
      • Introduction
      • Page
      • Page with amount control
      • Payout page
      • Frame
      • Widget
      • Status
    • Pay
      • Introduction
      • Cancel
      • Clearing
      • Refund
      • Status
    • Payout
      • Introduction
      • IBAN
      • Balance
      • Status by order_id
      • Status by Payment ID
      • Status by Payment ID V2
    • Mobile balance
      • Introduction
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Card
      • Introduction
      • Add
        POST
      • Add for payout
        POST
      • Remove
        POST
      • List
        POST
      • Status
        POST
    • Token
      • Introduction
      • Saved card with CVC input (Init)
      • Saved card with CVC input (Pay)
      • Non-acceptance payments
      • Non-acceptance payments (Pay)
      • Token payout
      • Status
    • Invoice
      • Introduction
      • Init
      • Info
      • Pay
      • Status
    • Additional
      • Introduction
      • Check request
      • Result notify
      • Payout notify
      • Redirect back
  • Card API
    • Introduction
    • Payment Cards
      • Reference
        • Request Status
        • Client product
        • Card product
        • Card status
        • Card block
        • Transaction
        • Error codes
      • Card issue
        • Bulk
        • Single
        • Physical
      • Card control
        • Activate
        • Block
        • Unblock
        • Set PIN
        • Reset PIN counter
        • Close
        • Identification
        • Info
        • Balance
        • Secret data
        • Statement
      • Client
        • Create
        • Edit
        • Card list
      • Additional
        • Request status
    • Gift Cards
      • Introduction
      • Reference
        • Request status
        • Card status
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Introduction
      • Rates
    • Products
      • Introduction
      • Reference
        • Request
        • Product
        • Freedom POS
        • Freedom ECOM
        • Freedom BOX
        • Limits
      • Add user
      • Add product
      • Add user with product
      • Grant user
      • Send auth data
      • Request status
    • E-Money
      • Introduction
      • Reference
        • Request
        • Operation
        • Error codes
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Introduction
      • Android SDK
      • iOS SDK
      • Reference
        • Error codes
      • Link
      • Token
      • Token refresh
      • Info
      • Profile
      • Request
  • Mobile SDK
    • Payment SDK
      • iOS
      • Android
    • Freedom QR
      • Reader SDK (Android)
      • Provider SDK (Android)
  • CMS
    • Introduction
    • Get Merchant ID and key
    • WordPress
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
      • Update
    • Tilda
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • InSales
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Ecwid
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Bitrix
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • PrestaShop
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • OpenCart
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
  1. Card

List

POST
https://api.freedompay.kg/v1/merchant/{paybox_merchant_id}/cardstorage/list

Request

Path Params
paybox_merchant_id
string 
required
Body Params multipart/form-data
pg_merchant_id
integer 
required
Merchant ID in the system {{project}}.
pg_user_id
integer 
required
User ID in the merchant system.
Example:
1234
pg_salt
string 
required
A random string consisting of arbitrary numbers and Latin letters.
Example:
some random string
pg_sig
string 
required
Request signature.
pg_extend_data
boolean 
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.
Example:
1

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.freedompay.kg/v1/merchant//cardstorage/list' \
--form 'pg_merchant_id=""' \
--form 'pg_user_id="1234"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""' \
--form 'pg_extend_data="1"'

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>
Previous
Remove
Next
Status