Create transaction

Developing

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

request_id

string

required

Unique request ID in the partner's system (uuid)

transaction

object

required

Transaction data

order_id

string

optional

Transaction ID in the partner's system

type

string

required

Transaction type. Dictionary.

description

string

optional

Transaction description

debit

object

optional

Debit details

amount

number

optional

Debit amount

currency

string

optional

Debit currency

terminal_number

string

optional

Debit terminal number

additional_amount

object

optional

Additional amount details

client

object

optional

Client details

card

object

optional

Card details

account

object

optional

Account details

credit

object

optional

Credit details

amount

number

optional

Credit amount

currency

string

optional

Credit currency

terminal_number

string

optional

Credit terminal number

additional_amount

object

optional

Additional amount details

client

object

optional

Client details

card

object

optional

Card details

account

object

optional

Account details

additional_parameters

array [object {2}]

optional

Array of additional parameters

type

string

optional

Additional parameter type

value

string

optional

Additional parameter value

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

status

string

required

Indicates the request reception status: ok - Request was successful, error - Request encountered an error

request_status

string

required

Indicates the request execution status. Reference value.

string

required

Request date and time in RFC 3339 format. Format: YYYY-MM-DDThh:mm:ss±hh:mm

Example

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

Request' status

Clearing transaction