Список транзакций

Список транзакцийServer-sideAdmin

get/merchants/{merchant_id}/reports/transactions/registry.{format}

Возвращает список с подробной информацией об успешных и отмененных транзакциях за указанный период. В ответе вы получите данные о платежах, включая информацию о комиссиях, налогах, а также о заказе и пользователе. Список доступен в формате JSON или CSV. Вы можете использовать этот метод API для финансовой сверки.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

SecuritybasicAuth

Request

path Parameters

merchant_id required	integer ID продавца.
format required	string Формат данных. Enum: "json" "csv" "xls"

query Parameters

datetime_from

required

string <datetime>

Начало периода в формате ГГГГ-ММ-ДД. Не обязателен, если передан параметр limit.

Example: datetime_from=2023-02-08

datetime_to

required

string <datetime>

Конец периода в формате ГГГГ-ММ-ДД. Не обязателен, если передан параметр limit. Диапазон дат между datetime_from и datetime_to не может превышать 92 дня.

Example: datetime_to=2023-03-08

in_transfer_currency

required

integer

Получение финансовых данных в валюте выплаты (по умолчанию используется валюта способа оплаты).

show_total

required

boolean

Включать ли итоговые данные по транзакциям.

merchant_of_records

string or null

Зарегистрированный продавец. Может принимать значения xsolla, merchant или может не передаваться. Если merchant, возвращаются транзакции, сделанные через прямые аккаунты партнера. Если xsolla, возвращаются транзакции, сделанные не через прямые аккаунты партнера. Если значение не указано, возвращаются все транзакции.

Enum:	Description
merchant	Возвращаются транзакции, сделанные через прямые аккаунты партнера.
xsolla	Возвращаются транзакции, сделанные не через прямые аккаунты партнера.

project_id

integer

ID проекта.

show_dry_run

boolean

Должны ли в ответе быть тестовые платежи.

transfer_id

integer

ID выплаты.

report_id

integer

ID финансового отчета.

offset

integer

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

limit

integer

Лимит количества отображаемых транзакций на странице. Если передан этот параметр, параметры datetime_from и datetime_to передавать не нужно.

status

string

Статус транзакции.

Enum: "done" "canceled" "error"

Responses

200

Список транзакций успешно получен.

Request samples

Response samples

application/json

[{"payment_details": {"chargebackPenalty": {"amount": 0
},
"commission_agent": {"amount": 0,
"percent": 0
},
"commission_agent_fixed": 0,
"commission_ps": {"amount": 0,
"fixed_amount": 0,
"percent": 0
},
"commission_ps_from_vat": {"amount": 0
},
"commission_user": {"amount": 0.01,
"percent": 33.33
},
"commission_xsolla": {"amount": 0,
"fixed_amount": 0,
"percent": 5
},
"cpa_network_commission": {"amount": 0,
"percent": 0
},
"direct_wht": {"amount": 0,
"percent": 0
},
"payment": {"amount": 0.03,
"amount_from_ps": 0,
"currency": "USD"
},
"payout": {"amount": 0.02,
"amount_from_ps": 0,
"currency": "RUB",
"fx_rate": 64.1386407767,
"percent": 100
},
"refundPenalty": {"amount": 0
},
"repatriation_costs": {"amount": 0,
"percent": 0
},
"sales_tax": {"amount": 0,
"percent": 0
},
"vat": {"amount": 0,
"percent": 0,
"user_amount": 0,
"user_percent": 0
}
},
"purchase": {"friend": {"email": null,
"user_id": null
},
"items_amount": 1,
"pin_codes": {"amount": null,
"content": null,
"currency": null
},
"purchase_amount": 0.02,
"simple_checkout": {"amount": null,
"currency": null
},
"subscription": {"name": null,
"plan_id": null,
"product_id": null,
"product_name": null,
"subscription_id": null
},
"virtual_currency": {"amount": 0.02,
"currency": "USD"
},
"virtual_currency_amount": 1,
"virtual_items": {"amount": null,
"content": null,
"currency": null
}
},
"transaction": {"custom_parameters": null,
"direct_account": 0,
"dry_run": 0,
"external_id": null,
"id": 418756634,
"payment_method": {"class": "Digital Payment Methods",
"id": 2760,
"name": "Your Balance"
},
"project": {"id": 21092,
"name": "Smith"
},
"refund_reason": null,
"refund_reason_comment": null,
"status": "done",
"transfer_date": "2019-02-11T13:32:00+03:00"
},
"user": {"country": "US",
"custom": null,
"email": "email@example.com",
"id": "smith123",
"ip": "209.11.22.33",
"marketplace": "Pay Station",
"name": "Tom",
"phone": null
},
"user_balance": {"payment_currency": {"deduction_amount": 0,
"payout_amount_from_balance": 0.02,
"purchase_amount_from_balance": 0.02
}
}
}
]