Freedom Pay
  1. Reference
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
      • Add for payout
      • Remove
      • List
      • Status
    • 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. Reference

Client product

CodeDescription
1000Freedom Wallet Card.
2000Instant Card.
3000Electron Card.

Parameters for the Method: Creating a Client Card with product_id = 1000#

Parameter NameParameter NameParameter NameDescriptionType
request_id (required)Unique request number in the partner's system (UUID).string/uuid
product_id (required)Identifier for the product within which the client is created.integer
client (required)phone (required)Client's phone number.integer
typeClient type:
1 - Individual
2 - Legal Entity
3 - Individual Entrepreneur
integer
residentResidency status:
1 - Resident
2 - Non-resident
integer
first_name (required)Client's first name (Latin characters).string
last_name (required)Client's last name (Latin characters).string
middle_nameClient's middle name (Latin characters).string
birthdateDate of birth of the cardholder (Format: YYYY-MM-DD).date
emailClient's email address.string
country (required)Country of client's residency (alpha-3 format).string
person_id (required)Client's identifier in the country of residency (e.g., Tax ID for Kazakhstan, Personal ID for Russia).string
languageClient's communication language (alpha-2 format).string
document (required)A scanned copy of an identity document:
- File format: PDF
- Base64 encoding
- Max size: 2 MB
string
address1 (required)country (required)Registration country (alpha-3 format).string
postal_code (required)Postal code.string
address_line1 (required)Registration city.string
address_line2 (required)Registration street.string
address_line3 (required)Registration building and premises.string
address2 (required)country (required)Residential country (alpha-3 format).string
postal_code (required)Postal code.string
address_line1 (required)Residential city.string
address_line2 (required)Residential street.string
address_line3 (required)Residential building and premises.string
external_user_idIdentifier of the client in the partner's system.string
identification_info (required)idn_date (required)Date of identification in RFC 3339 format (YYYY-MM-DDThh:mm:ss±hh:mm).string
identified_by (required)Identifier of the user who conducted the client's identification.string

Parameters for the Method: Creating a Client Card with product_id = 2000#

Parameter NameChild Parameter NameSub-Child Parameter NameDescriptionType
request_id (required)Unique request number in the partner's system (UUID).string/uuid
product_id (required)Identifier for the product within which the client is created.integer
client (required)phone (required)Client's phone number.integer
type (required)Client type:
1 - Individual
2 - Legal Entity
3 - Individual Entrepreneur
integer
resident (required)Residency status:
1 - Resident
2 - Non-resident
integer
first_name (required)Client's first name (Latin characters).string
last_name (required)Client's last name (Latin characters).string
Previous
Request Status
Next
Card product