API Reference

https://pay.alfabit.org/

Получение списка ордеров мерчанта с типизированным поиском

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
merchantsUidsstring[]Optional

Uid мерчантов

Example: ["3422b448-2460-4fd2-9183-8000de6f8343"]
billingTagsstring[]Optional

Биллинг тэг

Example: ["test@example.com"]
assetsstring[]Optional

Активы

Example: ["USDT"]
networksstring[]Optional

Сети

Example: ["ETH"]
createdAtSincestring · date-timeOptional

Дата создания (начало периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
createdAtBeforestring · date-timeOptional

Дата создания (конец периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
showProtectedMerchantsOrdersbooleanOptional

Показать ордера защищаемых (внутренних) мерчантов

Example: false
searchTypestring · enumOptional

Тип реквизитов для поиска

Possible values:
searchTextstringOptional

Текст для поиска в реквизитах указанного типа

Example: some_text
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение списка ордеров мерчанта

application/json
get
/api/v2/integration/orders
chevron-rightПримечаниеhashtag

Для получения данных по всем ордерам рекомендуется использовать версию /api/v2/integration/orders Параметры statuses, types, merchantsUids, billingTags и assets метода /client/v1/api/orders фактически являются массивами строк. Пример использования:

curl -X 'GET' 'https://gateway.tst.alfacore.net/client/v1/api/orders?statuses=failed&types=invoice&types=invoice-without-amount&assets=BTC&assets=BNB'

Примеры и схему ответов можно посмотреть в соответствующем подразделе метода. Описания статусов заявок:

  • created - Заявка успешно создана.

  • success - Заявка успешно выполнена.

  • failed - Выполнение заявки завершилось неудачей.

  • inProgress - Заявка находится в процессе выполнения.

  • invoiceWaitCreate - Ожидание создания счета.

  • invoiceNotCreated - Счет не был создан.

  • invoiceWaitRequisites - Ожидание предоставления реквизитов для создания счета.

  • invoiceWaitPay - Ожидание оплаты по счету.

  • invoiceWaitCheck - Ожидание проверки оплаты.

  • invoiceWaitConfirms - Транзакция в сети, ожидаем подтверждения.

  • invoiceNotPayed - Оплата по счету не произведена.

  • invoiceCheckBlocked - Проверка оплаты заблокирована.

  • transferBlocked - Перевод заблокирован.

  • exchangeBlocked - Обмен заблокирован.

  • withdrawBlocked - Вывод средств заблокирован.

Жизненный цикл статусов заявок:

  • Не было выбрано чем платить

created -> invoiceWaitCreate -> invoiceNotCreated

  • Выбрано чем платить, но не оплачено

created -> invoiceWaitCreate -> invoiceWaitRequisites -> invoiceWaitPay -> invoiceNotPayed

  • Был оплачен, но блок AML

created -> invoiceWaitCreate-> invoiceWaitRequisites -> invoiceWaitPay -> invoiceWaitCheck -> invoiceCheckBlocked

  • Был оплачен, транзакция появилась в сети и ждёт подтверждений (для активов, которые не проверяются на AML)

created -> invoiceWaitCreate-> invoiceWaitRequisites -> invoiceWaitPay -> invoiceWaitConfirms

  • Успешно завершен (inProgress = принято и позитивный AML, началось хеджирование и т.д., можно отгружать товар)

created -> invoiceWaitCreate -> invoiceWaitRequisites-> invoiceWaitPay -> invoiceWaitCheck -> inProgress -> success

Получение информации по ордеру

get
Path parameters
orderUidstringRequired
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение информации по ордеру

application/json
get
/api/v1/integration/orders/{orderUid}

Создание инвойса

post

Создание инвойса с указанием суммы оплаты. Инвойс формируется в валюте invoiceAssetCode. Платеж производится в валюте, указанной в параметре currencyInCode. Если не заполнено - покупателю будет предложен список доступных для оплаты валют.

Header parameters
x-api-keystringRequired
Body
currencyInCodestringOptional

Валюта, выбранная для оплаты покупателем

Example: BTC
invoiceAssetCodestringRequired

Ассет, в котором выстален счет покупателю

Example: USDT
commentstring · min: 5Optional

Комментарий к ордеру. Опциональное поле

Example: Заказ №234
publicCommentstring · min: 5Optional

Публичный комментарий к ордеру. Опциональное поле

Example: Заказ №234
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
redirectUrlstring · min: 5Optional

Url для перенаправления покупателя после оплаты

Example: https://marketplace.com/cart
isBayerPaysServicebooleanOptional

Включить комиссию сервиса в счет покупателю (если не указано, то берется из настроек мерчанта)

Example: true
isAwaitRequisitesbooleanOptional

Ожидать реквизиты для оплаты в респонсе (по дефолту false)

Example: true
expiryDurationMinutesnumberOptional

Время жизни инвойса, в минутах (по дефолту 20)

Example: 20
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
invoiceAmountstringRequired

Сумма для оплаты в $invoiceAssetCode

Example: 5000
Responses
chevron-right
200

Успешное создание инвойса

application/json
post
/api/v1/integration/orders/invoice
chevron-rightПримечаниеhashtag
  1. Инвойс (счет на оплату) должен быть сформирован в валюте, указанной в параметре invoiceAssetCode. Однако платеж может быть произведен в другой валюте, указанной в параметре currencyInCode. Если параметр currencyInCode не заполнен, покупателю будет предложен список доступных для оплаты валют.

  2. При обращении к методу существует 2 формата получения реквизитов -Получение реквизитов в ответе -Получение реквизитов в вебхуке Для переключения между режимами необходимо использовать параметр isAwaitRequisites (boolean)

Создание вывода

post

Вывод средств на внешний адрес.

Header parameters
x-api-keystringRequired
Body
amountstringRequired

Сумма выхода

Example: 10
toCurrencyCodestringRequired

Валюта получения (с сетью)

Example: USDTMATIC
recipientstringRequired

Реципиент (адрес)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Мемо тег (для XRP, TON и т.д.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
commentstringOptional

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
Responses
chevron-right
200

Успешное создание вывода

application/json
post
/api/v1/integration/orders/withdraw

Создание фиатного вывода

post

Эндпоинт позволяет создать заявку на вывод фиатных средств для мерчанта. Основные параметры вывода: currency - валюта amount - сумма paymentMethod - метод вывода, providerOutAliasCode - код банка вывода code - код способа вывода Для получения данных по доступным способам, банкам, лимитам, кодам вывода и тд. обратитесь к API методу fiat-withdraw-config.

Header parameters
x-api-keystringRequired
Body
currencystring · enumRequired

Валюта

Example: CODEPossible values:
paymentMethodstring · enumRequired

Платежный метод

Example: cardPossible values:
providerOutAliasCodestringRequired

Код банка вывода

Example: BANK
codestringRequired

Способ вывода

Example: CURRENCY_CARD_65
amountstringRequired

Сумма выхода

Example: 10
commentstringOptional

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
recipientstringRequired

Реквизиты реципиента

Example: CARD NUMBER
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
detailsobjectOptional

Доп поля для вывода

Example: {"email":"payer@gmail.com"}
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
Responses
chevron-right
200

Успешное создание фиатного вывода

application/json
post
/api/v1/integration/orders/fiat-withdraw

Создание фиатного инвойса

post

Эндпоинт позволяет создать заявку на оплату фиатного инвойса. Основные параметры инвойса: invoiceAssetCode - валюта invoiceAmount - сумма providerInAliasCode - код банка приема платежа paymentProviderAliasCode - код банка с которого будет происходить оплата code - код способа оплаты Для получения данных по доступным способам, банкам, лимитам, кодам оплаты и тд. обратитесь к API методу fiat-deposit-config.

Header parameters
x-api-keystringRequired
Body
commentstring · min: 5Optional

Комментарий к ордеру. Опциональное поле

Example: Заказ №234
publicCommentstring · min: 5Optional

Публичный комментарий к ордеру. Опциональное поле

Example: Заказ №234
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
redirectUrlstring · min: 5Optional

Url для перенаправления покупателя после оплаты

Example: https://marketplace.com/cart
isBayerPaysServicebooleanOptional

Включить комиссию сервиса в счет покупателю (если не указано, то берется из настроек мерчанта)

Example: true
isAwaitRequisitesbooleanOptional

Ожидать реквизиты для оплаты в респонсе (по дефолту false)

Example: true
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
invoiceAssetCodestringRequired

Ассет, в котором выстален счет покупателю

Example: RUB
expiryDurationMinutesnumberOptional

Время жизни инвойса, в минутах (по дефолту 15)

Example: 15
codestringOptional

Способ вывода

Example: CURRENCY_CARD_65
providerInAliasCodestringRequired

Банк приема платежа

Example: BANK
paymentProviderAliasCodestringOptional

Банк с которого будет происходить оплата

Example: BANK
invoiceAmountstringRequired

Сумма для оплаты в $invoiceAssetCode

Example: 5000
Responses
chevron-right
200

Успешное создание фиатного инвойса

application/json
post
/api/v1/integration/orders/fiat-invoice

Создание обмена

post

Конвертация на сумму amountIn в валюте assetCodeIn в валюту assetCodeOut. Система поддерживает два режима приоритета: exchangePriority: "in" - фиксируется сумма входа (amountIn) exchangePriority: "out" - фиксируется сумма выхода (amountOut)

Header parameters
x-api-keystringRequired
Body
assetCodeInstringRequired

Ассет на входе в обмен

Example: USDT
amountInnumberOptional

Обмениваемая сумма (обязательно если exchangePriority=in)

Example: 10
assetCodeOutstringRequired

Ассет на выходе

Example: USDT
amountOutnumberOptional

Ожидаемая сумма (обязательно если exchangePriority=out)

Example: 10
commentstringOptional

Комментарий к обмену. Опциональное поле

Example: Хеджирование за 07.2023
exchangePrioritystringOptional

Приоритет обмена (по дефолту "in")

Example: in
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
Responses
chevron-right
200

Успешное создание обмена

application/json
post
/api/v1/integration/orders/exchange

Создание перевода между аккаунтами

post

Перевод средств на другой аккаунт внутри системы.

Header parameters
x-api-keystringRequired
Body
amountnumberRequired

Сумма для перевода

Example: 10
assetCodestringRequired

Отправляемый ассет

Example: USDT
recipientIdnumberRequired

Реципиент (ID мерчанта)

Example: 7647
commentstringOptional

Комментарий к переводу. Опциональное поле

Example: С Днем Рождения!
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
Responses
chevron-right
200

Успешное создание перевода

application/json
post
/api/v1/integration/orders/account-transfer

Оценка входа

post

Метод предназначен для оценки суммы, которую необходимо заплатить в валюте fromCurrencyCode для получения суммы amountTo в валюте toCurrencyCode (с учетом курса обмена и комиссии).

Header parameters
x-api-keystringRequired
Body
fromCurrencyCodestringOptional

Валюта на входе

Example: BTC
toCurrencyCodestringRequired

Валюта на выходе

Example: USDTBEP20
amountTonumberRequired

Сумма на выходе

Example: 15
Responses
chevron-right
200

Успешная оценка входа

application/json
post
/api/v1/integration/orders/estimate-in

Оценка выхода

post

Метод предназначен для оценки суммы, которая будет получена в валюте toCurrencyCode при оплате суммы amountFrom в валюте fromCurrencyCode (с учетом курса обмена и комиссии).

Header parameters
x-api-keystringRequired
Body
toCurrencyCodestringRequired

Выходная валюта

Example: USDT-INTERNAL
fromCurrencyCodestringRequired

Отдаваемая валюта

Example: BTC-INTERNAL
amountFromnumberRequired

Отдаваемая сумма

Example: 15
Responses
chevron-right
200

Успешная оценка выхода

application/json
post
/api/v1/integration/orders/estimate-out

Создание инвойса без суммы

post

Создание инвойса без указания суммы оплаты. Инвойс формируется в валюте invoiceAssetCode. Платеж производится в валюте, указанной в параметре currencyInCode. Если не заполнено - покупателю будет предложен список доступных для оплаты валют.

Header parameters
x-api-keystringRequired
Body
currencyInCodestringOptional

Валюта, выбранная для оплаты покупателем

Example: BTC
invoiceAssetCodestringRequired

Ассет, в котором выстален счет покупателю

Example: USDT
commentstring · min: 5Optional

Комментарий к ордеру. Опциональное поле

Example: Заказ №234
publicCommentstring · min: 5Optional

Публичный комментарий к ордеру. Опциональное поле

Example: Заказ №234
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
redirectUrlstring · min: 5Optional

Url для перенаправления покупателя после оплаты

Example: https://marketplace.com/cart
isBayerPaysServicebooleanOptional

Включить комиссию сервиса в счет покупателю (если не указано, то берется из настроек мерчанта)

Example: true
isAwaitRequisitesbooleanOptional

Ожидать реквизиты для оплаты в респонсе (по дефолту false)

Example: true
expiryDurationMinutesnumberOptional

Время жизни инвойса, в минутах (по дефолту 20)

Example: 20
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
Responses
chevron-right
200

Успешное создание инвойса без суммы

application/json
post
/api/v1/integration/orders/invoice/without-amount

Создание заявки на Валюта -> Валюта (мост)

post

Заявка на конвертацию и перевод средств между различными сетями. Процесс включает три этапа: Получение -> Обмен -> Вывод. Например, при переводе USDTERC20 в BNBBEP20: 1. Предоставляется адрес для внесения USDTERC20 (fromCurrencyCode) в сети Ethereum 2. Полученные средства конвертируются в BNB 3. BNB выводятся как BNBBEP20 (toCurrencyCode) на указанный адрес (recipient) в сети Binance Smart Chain

  Важно: Сумма перевода (amount) указывается в toCurrencyCode.
 
  Совет: Для оценки суммы fromCurrencyCode можно воспользоваться методом "orders/estimate-in".
Header parameters
x-api-keystringRequired
Body
amountstringRequired

Сумма выхода

Example: 10
toCurrencyCodestringRequired

Валюта получения (с сетью)

Example: USDTMATIC
recipientstringRequired

Реципиент (адрес)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Мемо тег (для XRP, TON и т.д.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
commentstringOptional

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
detailsobjectOptional

Детали для фиатных выводов

Example: {"method":"card"}
fromCurrencyCodestringRequired

Входная валюта

Example: BTC
Responses
chevron-right
200

Успешное создание СТС заявки

application/json
post
/api/v1/integration/orders/currency-to-currency

Создание заявки Вывод с обменом

post

Заявка на вывод с конвертацией. Процесс включает два этапа: Обмен -> Вывод. Например, при выводе USDT в BTC: 1. USDT (fromAssetCode) с баланса мерчанта конвертируются в BTC 2. BTC (toCurrencyCode) выводятся на указанный адрес (recipient) в сети Bitcoin.

  Важно:Сумма вывода (amount) указывается в toCurrencyCode.
 
  Совет: Для оценки суммы currencyInCode можно воспользоваться методом "orders/estimate-in".
Header parameters
x-api-keystringRequired
Body
amountstringRequired

Сумма выхода

Example: 10
toCurrencyCodestringRequired

Валюта получения (с сетью)

Example: USDTMATIC
recipientstringRequired

Реципиент (адрес)

Example: 0x0000000000000000000000000000000000000000
requisitesMemoTagstringOptional

Мемо тег (для XRP, TON и т.д.)

Example: 80576
callbackUrlstring · min: 5Optional

Callback url для отправки хуков

Example: https://api.myip.com
commentstringOptional

Комментарий к переводу. Опциональное поле

Example: Оплата сервера за 07.2023
idempotencyKeystring · max: 255Optional

Ключ идемпотентности для предотвращения дублирования заявок при сетевых разрывах и состоянии гонки. Должен быть уникальным для каждого мерчанта.

Example: unique-request-id-12345
fromAssetCodestringRequired

Ассет из которого конвертируется

Example: BTC
Responses
chevron-right
200

Успешное создание заявки на вывод с обменом

application/json
post
/api/v1/integration/orders/withdraw-with-exchange

Получить значения для фильтра ассетов

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Возвращает массив строк, которые возможно использовать как фильтр для query-параметра "assets" в эндпоинте получения списка ордеров

application/json
get
/api/v1/integration/orders/filters/assets

Получить значения для фильтра сетей

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Возвращает массив строк, которые возможно использовать как фильтр для query-параметра "networks" в эндпоинте получения списка ордеров

application/json
get
/api/v1/integration/orders/filters/networks

Получение доступных пар обмена мерчанта

get
Query parameters
fromstringOptional

Код получаемого токена

Example: QWRUB
tostringOptional

Код отдаваемого токена

Example: ETH
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение пар обмена мерчанта

application/json
get
/api/v1/integration/assets/exchange-rate

Получение включенных ассетов мерчанта

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение включенных ассетов мерчанта

application/json
get
/api/v1/integration/assets/enabled

Получение настроек ассетов мерчанта

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение настроек ассетов мерчанта

application/json
get
/api/v1/integration/assets/settings

Получение валют мерчанта

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение валют мерчанта

application/json
get
/api/v1/integration/assets/currencies

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

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение списка доступных ассетов

application/json
get
/api/v1/integration/assets

Получение комиссий для вывода ассетов

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение комиссий для вывода

application/json
get
/api/v1/integration/assets/withdraw-fee

Получение информации о мерчанте

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение информации по мерчанту

application/json
get
/api/v1/integration/merchant

Получение тарифа мерчанта

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение тарифа мерчанта

application/json
get
/api/v1/integration/merchant/pricing

Получение валют мерчанта

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение балансов мерчанта

application/json
get
/api/v1/integration/merchant/balances

Получить крипто адреса мерчанта

get
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение крипто адресов мерчанта

application/json
get
/api/v1/integration/merchant/deposit-wallets

Получить список биллингов мерчанта

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
searchstringOptional

Поиск

Example: test@mail.com
billingUidstringOptional

Uid биллинга

Example: 54950452-ce8a-4595-a2fb-42c5e18032cc
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение списка биллингов мерчанта

application/json
get
/api/v1/integration/merchant/billings

Получить/создать биллинг

post
Path parameters
billingTagstringRequired
Header parameters
x-api-keystringRequired
Body
publicNamestringOptional

Публичное имя счета (показывается покупателю)

Example: Аккаунт BlackKnight165
Responses
chevron-right
200

Успешное получение списка биллингов мерчанта

application/json
post
/api/v1/integration/merchant/billings/{billingTag}

Получить список фиатных способов вывода

get
Path parameters
currencystringRequired
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Эндпоинт позволяет получить список доступных способов для вывода фиатных средств для мерчанта. Эти данные необходимы для формирования запроса API метода fiat-withdraw

application/json
get
/api/v1/integration/merchant/fiat-withdraw-config/{currency}

Получить список фиатных способов пополнения

get
Path parameters
currencystringRequired
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Эндпоинт позволяет получить список доступных способов для приема фиатных средств для мерчанта. Эти данные необходимы для формирования запроса API метода fiat-deposit

application/json
get
/api/v1/integration/merchant/fiat-deposit-config/{currency}

Получение списка ордеров мерчанта с типизированным поиском

get
Query parameters
pagenumberOptional

Страница

Example: 1
limitnumberOptional

Кол-во элементов на странице

Example: 10
orderBystringOptional

Сортировка по полю

Example: -uid
merchantsUidsstring[]Optional

Uid мерчантов

Example: ["3422b448-2460-4fd2-9183-8000de6f8343"]
billingTagsstring[]Optional

Биллинг тэг

Example: ["test@example.com"]
assetsstring[]Optional

Активы

Example: ["USDT"]
networksstring[]Optional

Сети

Example: ["ETH"]
createdAtSincestring · date-timeOptional

Дата создания (начало периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
createdAtBeforestring · date-timeOptional

Дата создания (конец периода) строка должна соответствовать формату ISO8601 и быть в экранированном URL-encoded format. Допустимо 2025-01-14T21:00:00.000%2b03:00 знак "+" -> "%2B" или 2025-01-14T21:00:00.000Z. Правильно 2025-01-14T21%3A00%3A00.000%2B03%3A00

Example: 1970-01-01T00:00:00.000Z
showProtectedMerchantsOrdersbooleanOptional

Показать ордера защищаемых (внутренних) мерчантов

Example: false
searchTypestring · enumOptional

Тип реквизитов для поиска

Possible values:
searchTextstringOptional

Текст для поиска в реквизитах указанного типа

Example: some_text
Header parameters
x-api-keystringRequired
Responses
chevron-right
200

Успешное получение списка ордеров мерчанта

application/json
get
/api/v2/integration/orders

Last updated