create payment - Freedom Pay

Request

Header Params

Accept

string

required

Indicates the media types that the client is able to understand from the server response.

Default:

application/json

Content-Type

string

required

Specifies the media type of the resource being sent to the server.

Default:

application/json

X-JWS-Signature

string

required

Request signature.

Example:

eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1NiJ9.eyJpc3MiOiJleGFtcGxlLmNvbSIsInN1YiI6InVzZXIxMjMiLCJhdWQiOiJhcGkuZXhhbXBsZS5jb20iLCJleHAiOjE2MzAwMDAwMDAsImlhdCI6MTYyOTk5NjQwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

X-Action

string

required

Invoked method.

Default:

gateway.payment.create

X-Request-Id

string

required

Unique request ID (UUID).
If the same request_id is sent more than once, the API guarantees idempotent behavior and returns the original response.

Example:

01978c2b-f191-7b56-92f8-20c7c401d1fc

Body Params application/json

amount

number <float>

required

Payment amount.

currency

string

required

Payment currency.

Example:

KZT

description

string

required

Payment description.

Example:

description

order_id

string

required

Order number in the merchant's system.
If the same order_id is sent more than once, the API guarantees idempotent behavior and returns the original response.

Example:

1234

user_id

string

optional

Client ID.

Example:

12345

auto_clearing

boolean

required

Flag indicating the need for automatic clearing.

Default:

true

from

object

required

type

string

required

Type of the debit object.

Examples:

cardtokenizedrecurrentsaved

card

object

required if type=card or saved

optional

Object containing card data.

recurrent

object

required if type = recurrent

optional

Contains info about starting a recurrent profile or performing a recurrent payment.

device

object

optional

Payer’s device information.

user_ip

string

optional

Client’s IP address.

Example:

84.252.158.239

Examples

CardRecurrent

{
    "amount": 100,
    "currency": "KZT",
    "description": "description",
    "order_id": "1234",
    "user_id": "12345",
    "auto_clearing": false,
    "from": {
        "type": "card",
        "card": {
            "name": "Test Test",
            "pan": "4400444400004440",
            "cvc": "123",
            "year": 30,
            "month": 5
        }
    },
    "device": {
        "user_ip": "84.252.158.239"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

cURL

CardRecurrent

curl --location --request POST 'https://api.freedompay.kz/v5/g2g/create' \
--header 'Accept;' \
--header 'X-JWS-Signature;' \
--header 'X-Action;' \
--header 'X-Request-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 100,
    "currency": "KZT",
    "description": "description",
    "order_id": "1234",
    "user_id": "12345",
    "auto_clearing": false,
    "from": {
        "type": "card",
        "card": {
            "name": "Test Test",
            "pan": "4400444400004440",
            "cvc": "123",
            "year": 30,
            "month": 5
        }
    },
    "device": {
        "user_ip": "84.252.158.239"
    }
}'

Responses

🟢200OK

application/json

Headers

x-request-id

string

required

Request ID (UUID), equals X-Request-Id from request headers.

Example:

01978c2b-f191-7b56-92f8-20c7c401d1fc

x-request-status

string

required

Request status.

Default:

success

x-datetime

string

required

Request datetime.

Example:

2025-06-20T07:13:31Z

Body

id

string

required

Payment ID (UUID)

Example:

01978c37-a961-7d20-8434-632242b24d48

status

string

required

Payment status

Examples:

processsuccesserror

amount

number <float>

required

Payment amount

created_at

string

required

Payment datetime

Example:

2025-06-20T07:13:31.068188524Z

error

object

optional

Object for an error

code

string

optional

Error code

Example:

10045

description

string

optional

Error description

Example:

Charge from card declined due to security reasons.

Examples

Status "process"Status "error"

{
    "id": "01978c37-a961-7d20-8434-632242b24d48",
    "status": "process",
    "amount": 100,
    "created_at": "2025-06-20T07:13:31.068188524Z"
}

🟠422Unprocessable Entity