Freedom Pay
  1. create
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Overview
        • Card
        • IBAN
        • Balance
        • Status
      • Transfer
        • Overview
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Overview
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Overview
        • Token Pay
        • Apple Pay
        • Google Pay
        • Token Payout
        • Status
    • Async API
      • Overview
      • create
        • create payment
          POST
        • create payment recurrent
          POST
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • 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
      • 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 by order_id
      • Status by Payment ID
      • Status
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Init
      • Info
      • Pay
      • Status
    • SDK
      • JS SDK
      • Google Pay
      • Freedom QR
        • Reader SDK (Android)
        • Provider SDK (Android)
      • Payment SDK
        • iOS
        • Android
    • 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
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Card API
    • Overview
    • Payment Cards
      • Overview
      • Dictionaries
      • Bulk issue
      • Issue card
      • Issue plastic card
      • Activate card
      • Block card
      • Unblock card
      • Set PIN
      • Reset PIN counter
      • Close card
      • Update client
      • Card info
      • Balance
      • Secret data
      • Secret data (version 2)
      • Statement
      • Statement extended
      • Create client
      • Edit client
      • Сards' list
      • Request' status
      • Create transaction
      • Clearing transaction
      • Refund transaction
      • Transaction request' status
      • Transaction info
    • Gift Cards
      • Overview
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Overview
      • Design
      • iOS SDK
      • Android SDK
      • OAuth2
        • Authorization link
        • Token exchange
        • Token refresh
        • User info
        • Request profile
        • Get profile status
        • Create user
        • Update user
      • OIDC
        • Authorization endpoint
        • Token exchange
        • Userinfo
      • Error codes
      • Examples
        • Keycloak
    • Transfer
      • Overview
      • Get token
      • Refresh token
      • Get agents
      • Fees
      • Create person
      • Create business
      • Create transfer
      • Print application
      • Confirm
      • Search
      • Payout
      • Payout confirm
      • Cancel
      • Get person info
      • Get business info
      • Status
      • Info
    • Device ID
      • Android SDK
      • iOS SDK
  1. create

create payment recurrent

POST
https://api.freedompay.kz/v5/g2g/create

Request

Header Params
X-JWS-Signature
string 
required
Example:
{{tmp_jws_signature}}
X-Action
string 
required
Example:
gateway.payment.create
X-Request-Id
string 
required
Example:
{{$randomUUID}}
Body Params application/json
amount
integer 
required
currency
string 
required
description
string 
required
order_id
string 
required
user_id
string 
required
auto_clearing
boolean 
required
from
object 
required
type
string 
required
recurrent
object 
required
device
object 
required
user_ip
string 
required
urls
object 
required
check_url
string 
required
result_url
string 
required
Example
{
  "amount": 10,
  "currency": "KZT",
  "description": "description",
  "order_id": "1234",
  "user_id": "12345",
  "auto_clearing": false,
  "from": {
    "type": "recurrent",
    "recurrent": {
      "profile_id": "0190fddd-bea7-7f17-b777-10344d5cc816"
    }
  },
  "device": {
    "user_ip": "84.252.158.239"
  },
  "urls": {
    "check_url": "https://webhook.site/f99d3537-3f36-42a2-8206-67684739d51e",
    "result_url": "https://webhook.site/f99d3537-3f36-42a2-8206-67684739d51e"
  }
}

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.kz/v5/g2g/create' \
--header 'X-JWS-Signature: {{tmp_jws_signature}}' \
--header 'X-Action: gateway.payment.create' \
--header 'X-Request-Id: {{$randomUUID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 10,
    "currency": "KZT",
    "description": "description",
    "order_id": "1234",
    "user_id": "12345",
    "auto_clearing": false,
    "from": {
        "type": "recurrent",
        "recurrent": {
            "profile_id": "0190fddd-bea7-7f17-b777-10344d5cc816"
      }
    },
    "device": {
        "user_ip": "84.252.158.239"
    },
    "urls": {
        "check_url": "https://webhook.site/f99d3537-3f36-42a2-8206-67684739d51e",
        "result_url": "https://webhook.site/f99d3537-3f36-42a2-8206-67684739d51e"
    }
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Previous
create payment
Next
read payment