Skip to main content

2.1.3. Response

FieldDescriptionTypeNotes
statussuccess
dataa map with the returned logArray

data Array Structure​

FieldDescriptionTypeNotes
transactionsan array of transactionsArray
paginationmap of pagination informationobject
statisticsmap of the statistics informationobject

transactions Array Structure​

FieldDescriptionTypeNotes
idtransaction IDstring
device_sndevice serial numberstring
bank_hosthost bank namestring
merchant_idmerchant IDsstring
terminal_idterminal IDsstring
transaction_typetransaction typestring“PURCHASE”, “REFUND” etc
approval_numberauthorization numberstring
amountamountintegerin cents
transaction_datetimetransaction date and timestringISO 8601
result_typetransaction resultstring“APPROVED”, “DECLINED”
rrnretrieval reference numberstring
innfiscal IDstring
card_product_namecard product namestring
org_nameorganization namestring
org_name_placepoint of sale namestring
receipt_numberreceipt numberstring
bank_card_numbermasked bank card numberstring
mccmerchant category codestring
read_typecard reading method typestring
result_coderesult codestring

pagination Object Structure​

FieldDescriptionTypeNotes
current_pagecurrent page numberinteger
per_pagenumber of records per pageinteger
total_pagestotal number of the pagesinteger
total_recordstotal number of the recordsinteger

statistics Object Structure​

FieldDescriptionTypeNotes
total_amountsuccessful transactions amountinteger

Exit codes:​

200 – success
400 – invalid request parameters

Code structure​

{
"status": "string, response status ('success')",
"data": {
"transactions": [
{
"id": "string, transaction ID",
"device_sn": "string, device serial number",
"bank_host": "string, host bank name",
"merchant_id": "string, merchant ID",
"terminal_id": "string, terminal ID",
"transaction_type": "string, transaction type ('PURCHASE', 'REFUND', etc.)",
"approval_number": "string, authorization number",
"amount": "integer, amount in cents",
"transaction_datetime": "string, transaction date and time (ISO 8601)",
"result_type": "string, transaction result ('APPROVED', 'DECLINED')",
"rrn": "string, retrieval reference number",
"inn": "string, fiscal ID",
"card_product_name": "string, card product name",
"org_name": "string, organization name",
"org_name_place": "string, point-of-sale name",
"receipt_number": "string, receipt number",
"bank_card_number": "string, masked bank card number",
"mcc": "string, merchant category code",
"read_type": "string, card reading method type",
"result_code": "string, result code"
}
],
"pagination": {
"current_page": "integer, current page number",
"per_page": "integer, number of records per page",
"total_pages": "integer, total number of pages",
"total_records": "integer, total number of records"
},
"statistics": {
"total_amount": "integer, total amount of successful transactions in cents"
}
}
}