Payments list request

The data transfer method can be POST or GET.

Payments lists requests are processed not more than one per minute.

The maximum number of transactions in the response is 10,000.

The requests contains certain fields:

Field	Description
merchant	unique merchant ID;
currency	requested currency (UAH, USD, EUR, KZT, BRL, INR and AZN);
order	the number of the transaction in the merchant’s system, from which the selection begins in the specified period (if 0 is transferred, then all transactions are returned);
start_date	date and time of the beginning of the period in the "YYYY-MM-DD HH:ii:ss" format;
finish_date	date and time of the end of the period in the "YYYY-MM-DD HH:ii:ss" format;
status	status of payments to be selected (all, success, pending, blocked, refund);
type	transaction type (withdrawal or deposit);
sign	digital signature with the merchant’s key. Available fields are: “merchant”, “currency”, “order”, “start_date”, “finish_date”, “status”, “type”. It is hashed using MD5 method (for more details read the “Digital signature in requests” section).

GET /api/payment-list

https://<provided url>
/api/payment-list

Examples of the request:

application/json

{
    "merchant" : "M1VJDHSI6DYXS",
    "currency" : "UAH",
    "order" : "0",
    "start_date" : "2021-02-09 00:00:00",
    "finish_date" : "2021-02-11 16:59:59",
    "status" : "all",
    "type" : "deposit",
    "sign" : "XXXXXXXXXXXXXXXXXX"
}

The response contains the fields:

Field	Description
id	unique transaction number;
uid	unique transaction ID (the same as “uuid”);
order_id	transaction number in the merchant system;
subtotal	amount transfered: In case of “Deposit” - to the merchant’s balance In case of “Withdrawal” - to the card
fee_percentage	deducted fee (if the type of fee is a per cent): In case of “Deposit” deducted from “total” In case of “Withdrawal” added to “subtotal”;
fee_fixed	fee rate (if the fee type is fixed): In case of “Deposit” deducted from “total” In case of “Withdrawal” added to “subtotal”;
total	total transaction amount: In case of “Deposit” - deposit amount without charging a fee In case of “Withdrawal” - payout amount with added fee;
type	transaction type (withdrawal or deposit);
status	transaction status (Success, Pending, Blocked, Refund);
created_at	transaction creation date and time;
updated_ad	transaction processing date and time.

Example of the response – Success status:

application/json

{
    "id" : 11114,
    "uid" : "ABA4OD7X73L4Q",
    "order_id" : "0083",
    "subtotal" : 0.9,
    "fee_percentage" : 0,
    "fee_fixed" : 0.1,
    "total" : 1,
    "currency" : "UAH",
    "type" : "Deposit",
    "status" : "Success",
    "created_at" : "2021-02-10 09:34:57",
    "updated_ad" : "2021-02-10 09:37:40"
}

Example of the response – Blocked status:

application/json

{
    "id" : 11115,
    "uid" : "XTJTEZXMJAUMT",
    "order_id" : "0084",
    "subtotal" : 0.9,
    "fee_percentage" : 0,
    "fee_fixed" : 0.1,
    "total" : 1,
    "currency" : "UAH",
    "type" : "Deposit",
    "status" : "Blocked",
    "created_at" : "2021-02-10 10:22:32",
    "updated_ad" : "2021-02-10 10:24:17"
}

Example of the response – Error status:

application/json

{
    "status": "Error",
    "description": "Please send one request per minute"
}