Status - Freedom Pay

Request

Body Params multipart/form-data

merchant_id

integer

required

Merchant ID in {{project}} issued upon connection.

invoice_id

integer

required

The unique identifier of the payment transaction in FreedomPay serves as the key for all further work with the transaction.
Required if empty order_id

order_id

string

optional

Payment ID in the merchant system. It is recommended to keep this field unique. Required if invoice_id is empty.

Example:

550e8400-e29b-41d4-a716-446655440000

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/merchant/invoice/status' \
--form 'merchant_id=""' \
--form 'invoice_id="";type=* The unique identifier of the payment transaction in {{project}} serves as the key for all further work with the transaction. Required if `order_id` is empty.' \
--form 'order_id="550e8400-e29b-41d4-a716-446655440000"'

Responses

🟢200Success

application/xml

Body

status

string

required

Shows the result of the query.

Status Description:

ok: Request was successful.

error: Request failed.

invoice_id

integer

required

The unique identifier of the payment transaction in {{project}} serves as the key for all further work with the transaction.

invoice_status

string

required

Payment status.

Status Description:

partial: New payment.

pending: Waiting for the payer or payment system.

refunded: Payment has been refunded.

revoked: Payment has been canceled.

ok: Payment completed successfully.

failed: Payment in error.

incomplete: Payment lifetime expired.

error_code

integer

optional

Error code ID.

error_description

string

optional

Text description of the error.

card_pan

string

optional

Masked card number (part of the digits of the card number are hidden). This parameter is passed only in case of successful payment with a bank card.

card_token

string

optional

Card Token.

amount

number

required

Order price.

currency

string

required

Order currency.

Example: KZT.

dt

string <date-time>

required

Date and time of the request. Format: YYYY-MM-DDThh:mm:ss±hh:mm.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <status>string</status>
  <invoice_id>0</invoice_id>
  <invoice_status>string</invoice_status>
  <error_code>0</error_code>
  <error_description>string</error_description>
  <card_pan>string</card_pan>
  <card_token>string</card_token>
  <amount>0</amount>
  <currency>string</currency>
  <dt>2019-08-24T14:15:22Z</dt>
</root>