Refund transaction

Developing

POST

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

This section describes the method for refunding a previously completed transaction. The refund can be either full or partial. If the amount field is not provided in the request, the refund will be processed for the full amount of the previously created transaction.

Request

Body Params application/json

request_id

string

required

Unique request ID in the partner system (UUID)

order_id

string

required

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

transaction_id

string

required

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

description

string

optional

Transaction description

amount

number

optional

Refund amount. If not provided, a full refund is processed.

Example

{
  "request_id": "string",
  "order_id": "string",
  "transaction_id": "string",
  "description": "string",
  "amount": 0
}

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/refund' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "order_id": "string",
    "transaction_id": "string",
    "description": "string",
    "amount": 0
}'

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"
}

Clearing transaction

Transaction request' status