Transaction info - Freedom Pay

Request

Body Params application/json

order_id

string

required

Transaction ID in the partner system. (required if no transaction_id)

transaction_id

string

required

Transaction ID in the Freedom Processing system. (required if no order_id)

Example

{
  "order_id": "string",
  "transaction_id": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.kz/v5/card-api/transaction/info' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

status

string

optional

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

request_status

string

optional

Indicates the request execution status. Reference value.

dt

string

optional

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

data

object

optional

transaction

object

optional

Transaction details

debit

object

optional

Debit details

credit

object

optional

Credit details

additional_parameters

array [object {2}]

optional

Additional parameters

refund_transactions

array [object {4}]

required

fin_documents

array [object {4}]

required

Example

{
  "status": "string",
  "request_status": "string",
  "dt": "string",
  "response_data": {
    "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"
      }
    ]
  }
}