1. Create
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Card data encryption
      • Payments
        • Overview
        • Pay by card
        • Pay by card: complete 3DS
        • Pay with Apple Pay
        • Pay with Google Pay
        • Pay by recurring profile
        • Create payment page
        • Create payment page with any amount
        • Capture payment (clearing)
        • Cancel payment
        • Refund payment
        • Get payment status
      • Payout
        • Overview
        • Pay out to card
        • Pay out to IBAN
        • Get payout balance
        • Get payout status
      • Transfer
        • Overview
        • Transfer from card to card
        • Transfer from card to card: complete 3DS
        • Get exchange rates
        • Get transfer status
      • Saved cards
        • Overview
        • Save card
        • Save card: complete 3DS
        • List saved cards
        • Remove saved card
        • Pay by card token
        • Pay out to card token
        • Get payment status
    • Async API
      • Overview
      • Create
        • Create payment
          POST
      • Read
        • Get payment status
        • Get request result
      • Edit
        • Capture payment (clearing)
        • Cancel payment (reverse)
        • Refund payment
  • Merchant API
    • Overview
    • Purchase
      • Overview
      • Checkout
      • Card token
        • Overview
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment (with CVC)
        • Confirm payment (with CVC)
        • Create payment
        • Confirm payment
      • Create payment
      • Any amount
      • Reccuring payment
      • Cancel payment
      • Clearing
      • Refund payment
      • Status
    • Payout
      • Overview
      • Card token
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment
      • Create payment
      • IBAN
      • Balance status
      • Status
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Recurring profile
        • Overview
        • Create
        • Cancel
        • Info
        • Notify
      • Tips
        • Overview
        • Create
      • Create
      • Execute
      • Info
      • Refund
      • Status
      • Cancel
    • SDK
      • JS SDK
      • Merchant SDK
        • Google Pay
        • Android
        • IOS
    • CMS
      • Overview
      • Get Merchant ID and key
      • WordPress
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
        • Update
      • Tilda
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • InSales
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Ecwid
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Bitrix
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • PrestaShop
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • OpenCart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
    • Installment
      • Overview
      • Status
        • Application Status
        • Application Callback Status
        • Application Change Status
      • Get partners
      • Create application
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Client request status
      • Create terminal
      • Update terminal limits
      • Product request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Device ID
      • Android SDK
      • iOS SDK
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
      • Status
    • Account
      • Overview
      • Create payment
      • Payment status
      • Batch statuses
      • Statement
      • Statement status
      • Balance
      • Balance status
    • Invoices
      • Info
  1. Create

Create payment

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/v5/g2g/create
Creates a payment by card, saved card, wallet token or recurrent profile.
The X-Action header must be gateway.payment.create.
Sign the request with X-JWS-Signature: see Async API Overview.
The payment is processed asynchronously: the response returns it with status process.

Payment flow by auto_clearing#

3DS challenge flow#

With a frictionless 3DS flow (3ds.flow_type = F) there is no waiting_3ds step.
The two-step flow after approved is shown in Capture payment (clearing).

Result#

ResponseMeaningNext step
status = processThe payment is accepted and is being processed.Get the final status with gateway.payment.status. If the response is lost, use gateway.request.status.
status = errorThe payment is declined.See «Errors» below.
{}, X-Request-Status: processThe result is not ready yet.Repeat the request in a few seconds with the same X-Request-Id.

Errors#

A declined payment is returned with HTTP 200, status error and the error object.
The error is returned in error.code and error.description.
HTTPerror.codeWhenWhat to do
200Decline code, for example 10045The payment is declined.Do not repeat the request with the same X-Request-Id: it returns the same result.
4009400The body is not valid JSON.Fix the request.
4019998The signature is invalid.Check the signature: see Async API Overview.
4229403A required header or field is missing or invalid, for example X-Request-Id is not a UUID. The reason is in error.description.Fix the request.
5009999Internal error at the gateway entry point.Repeat the request later with the same X-Request-Id.
50010000Internal error in payment processing.Repeat the request later with the same X-Request-Id.

Request

Header Params

Body Params application/json

Examples
{
  "amount": 100.5,
  "currency": "KZT",
  "description": "Order #1001",
  "order_id": "order_1001",
  "auto_clearing": false,
  "from": {
    "type": "card",
    "card": {
      "name": "IVAN IVANOV",
      "pan": "4716047261941981",
      "cvc": "123",
      "year": 30,
      "month": 12
    }
  },
  "device": {
    "user_ip": "84.252.158.239"
  }
}

Responses

🟢200OK
application/json
Headers

Bodyapplication/json

Examples
{
  "id": "01978c37-a961-7d20-8434-632242b24d48",
  "status": "process",
  "amount": 100.5,
  "created_at": "2026-06-20T07:13:31.068188524Z"
}
🟠422Unprocessable Entity
🟠400Bad Request
🟠401Unauthorized
🔴500Internal Server Error
Previous
Overview
Next
Get payment status