Skip to content
OhlaPay

Получение списка всех сделок

GET
/payment

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Secure-Key
required
string

API ключ, который привязан к вашему кабинету

Query Parameters

Section titled “Query Parameters ”
blockIndex
number
default: 1
Example
2

Номер запрашиваемого блока данных

blockCapacity
number
Example
50

Максимальное количество записей в одном блоке

sortKey
string

Атрибут, по которому выполняется упорядочивание данных

sortDirection
string
Allowed values: ASC DESC

Направление сортировки

status
string
Allowed values: pending active checking checking_manually manual_review dispute success_changed success canceled
Example
dispute

Опционально: статус сделок

begin
string

Опционально: дата начала

end
string

Опционально: конечная дата

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Получение списка всех сделок

object
elements
required

Детали о количестве элементов

object
aggregateVolume
required

Общее количество записей в выборке

number
Example
487
sliceSize
required

Сколько элементов содержится в текущем наборе данных

number
Example
25
segmentCount
required

Количество доступных сегментов данных

number
Example
20
activeSegment
required

Индекс активного сегмента

number
Example
3
segmentLimit
required

Лимит элементов на один сегмент

number
Example
25
result
required

Список сделок

Array<object>
object
category
required

Категория callback payload

string
Allowed values: trade matching
Example
trade
id
required

Уникальный идентификатор сделки

string
Example
9ee42dff-83ec-4a90-8dfb-1fc74d3afbe4
merchantTransactionId
required

Идентификатор транзакции мерчанта (внешний)

object
Example
MERCH-TRX-20240910-00042
matchingTransactionId

Идентификатор matching-транзакции, если callback относится к matching-linked pay-out.

object
Example
MATCHING-TRX-20240910-00042
amount
required

Сумма в фиатной валюте

number
Example
2500
crypto
required

Сумма в криптовалюте (для мерчанта)

string format: int64
Example
124825278
rate
required

Курс обмена фиат → крипто (для мерчанта)

number
Example
80.12
fee
required

Комиссия мерчанта

string format: int64
Example
125000
type
required

Тип сделки

string
Allowed values: pay-in pay-out
Example
pay-in
method
required

Метод реквизитов/оплаты

string
Allowed values: account ca_sbp ca_c2c sbp sbp_invoice qr qr_vietnam c2c ost_c2c c2c_invoice link foreign_sbp foreign_c2c alfa_tjs_sbp abh_sbp abh_c2c mobile_commercial mobile_commerce_tjs
Example
c2c
status
required

Текущий статус сделки

string
Allowed values: pending active checking checking_manually manual_review dispute success_changed success canceled
Example
active
requisite
required

Реквизиты для проведения сделки

object
id
required

Идентификатор реквизита

string
Example
a3c9f2e1-7d44-4c9a-9c21-8bfa11223344
ownerName
required

Имя владельца платёжного метода

string
Example
Иван Иванов
firstName

Owner first name, when the bank requires split owner name fields.

object
Example
Иван
lastName

Owner last name, when the bank requires split owner name fields.

object
Example
Иванов
bank
required

Идентификатор банка для сделки

string
Example
SBER
cardNumber
required

Номер карты платёжного метода

string
Example
548673******9012
sbpNumber
required

Номер телефона для СБП

string
Example
79035554433
link
required

Ссылка на платёжный метод

string
Example
https://pay.example.com/transfer/12345
qrCode
required

QR-код для отображения

string
Example
https://cdn.example.com/qrcode/payment.png
accountNumber
required

Номер банковского счёта

string
Example
RU02000000000000001234
bankBic

BIC банка для банковского счёта

object
Example
040702615
currency
required

Фиатная валюта платёжного метода

string
Example
RUB
crossBorderCurrency

Трансграничная валюта платёжного метода

object
Example
RUB
paymentPageUrl
required

Ссылка на внешнюю платёжную страницу, где клиент видит реквизиты, сумму и таймер

string
Example
https://pay.example.com/external/4b9a1a2c-9c10-4f6b-88aa-77bb66cc55dd
dispute
required

Информация о споре/отмене (если есть)

object
disputeCreatedAt
required

Дата и время создания спора

object
Example
2024-09-10T10:15:00.000Z
disputeResolvedAt
required

Дата и время разрешения спора

object
Example
2024-09-11T18:40:00.000Z
disputeMerchantCheckUrl
required

Ссылка для мерчанта на проверку чека по спору

object
Example
https://merchant.example.com/disputes/check/aa11bb22
disputeTraderCheckUrl
required

Ссылка для трейдера на проверку чека по спору

object
Example
https://trader.example.com/disputes/check/cc33dd44
disputeTraderFiatAmount
required

Фиатная сумма, заявленная трейдером в споре

object
Example
1800
disputeTraderDeclineReason
required

Причина отказа трейдера (если применимо)

object
Example
Платёж не найден в выписке банка
cancelReason
required

Причина отмены сделки (если применимо)

object
Example
Истекло время оплаты
payerInfo
required

Информация о плательщике (как хранится в системе)

object
userAgent
required

Строка, содержащая информацию о браузере и устройстве плательщика

string
Example
Mozilla/5.0 (Linux; Android 13; SM-G991B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Mobile Safari/537.36
ip
required

IP-адрес плательщика

string
Example
203.0.113.45
userId
required

Уникальный идентификатор пользователя в системе

string
Example
usr_847392
fingerprint

Хэш для уникальной идентификации устройства или сессии пользователя. Формируется в соответствии со стандартом FingerprintJS

string
Example
9d1f2c8a7b6e5d4c3a2f1e0d9c8b7a6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1
registeredAt

Временная метка, указывающая дату регистрации плательщика

string
Example
1714567890123
Example
{
  "name": "Алексей",
  "phone": "79001234567"
}
payerBank

Банк плательщика, если он был передан при создании pay-in.

object
Example
ALFA
paymentLifetime
required

Окно транзакции в минутах

number
Example
20
createdAt
required

Дата и время создания сделки

string format: date-time
Example
2024-09-10T10:00:00.000Z
invoicesUrl
required

Ссылка на инвойсы

Array<string>
nullable
Example
https://merchant.example.com/invoices/trade/c2f8a3e1
factFiatAmount

Фактическая выплаченная сумма для matching callback

number
nullable
Example
43650
tradeIdsAll

ID всех сделок, связанных с matching

Array<string>
tradeIdsSuccess

ID успешных сделок, участвующих в закрытии matching

Array<string>
receiptValidation

Краткий публичный результат проверки загруженного чека.

object
summary
required

Краткий публичный результат проверки чека.

string
Example
Требуется ручное решение.
matchingId

ID matching, если сделка привязана к matching.

object
matchingTradeType

Тип связи сделки с matching.

object