Freedom Pay
  1. Products
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
        POST
      • Add product
        POST
      • Add user with product
        POST
      • Grant user
        POST
      • Send auth data
        POST
      • Request status
        POST
    • 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. Products

Introduction

Interaction scheme#

products_connect.png

Authorization#

 Authorization of the request occurs by generating and transmitting the JWS token of the request in the X-JWS-Signature header. JWS is the part of the JWT token that contains only header and signature.
 Format of the transmitted data is application/json.

Example of signature formation#

Request body#

{
    "request_id": "828cf71d-a447-4a67-a149-c1df8bc197ca",
    "name": "Название юридического лица",
    "bin": 123456789012,
    "ceo_info": {
        "first_name": "Имя",
        "last_name": "Фамилия",
        "phone": 77017777777,
        "email": "mail@example.kz"
    },
    "address_info": {
        "country": "KZ",
        "postal_code": "050000",
        "address_line1": "Almaty",
        "address_line2": "Zheltoksan",
        "address_line3": "115" 
    },
    "iban": "KZ12345B789012345KZT",
    "description": "Новый партнер"
}

JWT token header#

{
    "uri": "/v5/partner/client/add",
    "auth_id": "123456",
    "method": "POST",
    "params": "",
    "alg": "HS256"
}
 The partner's key can be secret_key. In this case, the following JWT token can be generated:
eyJ1cmkiOiIvdjUvcGFydG5lci9jbGllbnQvYWRkIiwiYXV0aF9pZCI6IjEyMzQ1NiIsIm1ldGhvZCI6IlBPU1QiLCJwYXJhbXMiOiIiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0X2lkIjoiODI4Y2Y3MWQtYTQ0Ny00YTY3LWExNDktYzFkZjhiYzE5N2NhIiwibmFtZSI6ItCd0LDQt9Cy0LDQvdC40LUg0Y7RgNC40LTQuNGH0LXRgdC60L7Qs9C-INC70LjRhtCwIiwiYmluIjoxMjM0NTY3ODkwMTIsImNlb19pbmZvIjp7ImZpcnN0X25hbWUiOiLQmNC80Y8iLCJsYXN0X25hbWUiOiLQpNCw0LzQuNC70LjRjyIsInBob25lIjo3NzAxNzc3Nzc3NywiZW1haWwiOiJtYWlsQGV4YW1wbGUua3oifSwiYWRkcmVzc19pbmZvIjp7ImNvdW50cnkiOiJLWiIsInBvc3RhbF9jb2RlIjoiMDUwMDAwIiwiYWRkcmVzc19saW5lMSI6IkFsbWF0eSIsImFkZHJlc3NfbGluZTIiOiJaaGVsdG9rc2FuIiwiYWRkcmVzc19saW5lMyI6IjExNSJ9LCJpYmFuIjoiS1oxMjM0NUI3ODkwMTIzNDVLWlQiLCJkZXNjcmlwdGlvbiI6ItCd0L7QstGL0Lkg0L_QsNGA0YLQvdC10YAifQ.HR6MSeTvX6MFbug2619WEUf2TyoQTi9XUKVU4QtXNAQ
 This line is the signature of the request and must be passed in the request header parameter X-JWS-Signature.
eyJ1cmkiOiIvdjUvcGFydG5lci9jbGllbnQvYWRkIiwiYXV0aF9pZCI6IjEyMzQ1NiIsIm1ldGhvZCI6IlBPU1QiLCJwYXJhbXMiOiIiLCJhbGciOiJIUzI1NiJ9..HR6MSeTvX6MFbug2619WEUf2TyoQTi9XUKVU4QtXNAQ
 Supported HS256 signature encryption algorithm.
Previous
Rates
Next
Request