Create transaction

POST

https://api.freedompay.kz/v5/card-api/transaction/create

This section describes the request for creating a new transaction. It specifies the required request parameters and data formats.

Request

Body Params application/json

Example

{
  "request_id": "string/uuid",
  "transaction": {
    "order_id": "string",
    "type": "string",
    "description": "string"
  },
  "debit": {
    "amount": "number",
    "currency": "string",
    "terminal_number": "number",
    "additional_amount": {
      "type": "string",
      "amount": "number",
      "currency": "string"
    },
    "client": {
      "client_id": "string",
      "phone": "integer"
    },
    "card": {
      "card_id": "string",
      "card_pan": "string",
      "card_cvc": "integer",
      "card_month": "integer",
      "card_year": "integer",
      "name": "string"
    },
    "account": {
      "number": "string"
    }
  },
  "credit": {
    "amount": "number",
    "currency": "string",
    "terminal_number": "number",
    "additional_amount": {
      "type": "string",
      "amount": "number",
      "currency": "string"
    },
    "client": {
      "client_id": "string",
      "phone": "integer"
    },
    "card": {
      "card_id": "string",
      "pan": "string"
    },
    "account": {
      "number": "string"
    }
  },
  "additional_parameters": [
    {
      "type": "string",
      "value": "string"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/card-api/transaction/create' \
--header 'Content-Type: application/json' \
--data-raw '{
  "request_id": "string/uuid",
  "transaction": {
    "order_id": "string",
    "type": "string",
    "description": "string"
  },
  "debit": {
    "amount": "number",
    "currency": "string",
    "terminal_number": "number",
    "additional_amount": {
      "type": "string",
      "amount": "number",
      "currency": "string"
    },
    "client": {
      "client_id": "string",
      "phone": "integer"
    },
    "card": {
      "card_id": "string",
      "card_pan": "string",
      "card_cvc": "integer",
      "card_month": "integer",
      "card_year": "integer",
      "name": "string"
    },
    "account": {
      "number": "string"
    }
  },
  "credit": {
    "amount": "number",
    "currency": "string",
    "terminal_number": "number",
    "additional_amount": {
      "type": "string",
      "amount": "number",
      "currency": "string"
    },
    "client": {
      "client_id": "string",
      "phone": "integer"
    },
    "card": {
      "card_id": "string",
      "pan": "string"
    },
    "account": {
      "number": "string"
    }
  },
  "additional_parameters": [
    {
      "type": "string",
      "value": "string"
    }
  ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": "string",
    "request_status": "string",
    "dt": "string"
}

Modified at 2025-06-11 07:28:35

Request' status

Clearing transaction