Перейти к основному содержимому

Получение платёжного заказа

GET 
/api/orders

Возвращает информацию о платёжном заказе SCI по ID заказа мерчанта и, если указано, названию SCI.

Запрос​

Параметры Query

    orderId stringобязательно

    Возможные значения: <= 64 символов

    Идентификатор заказа мерчанта.

    Пример: test-order-001
    sciName string

    Название SCI-интеграции, необязательно.

    Пример: sandbox-sci

Ответы​

OK

Схема
    orderIdstring

    ID заказа.

    Пример: ORDER_123456
    sciNamestring

    Название SCI.

    Пример: test-value
    paymentStatusstring

    Статус платежа.

    Возможные значения: [PENDING, COMPLETED, CANCELED, REFUNDED]

    Пример: COMPLETED
    paymentMethodstring

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

    Возможные значения: [INTERNAL_OTHERS, CRYPTO_INVOICE]

    Пример: CRYPTO_INVOICE
    paymentCreateddate-time

    Время создания платежа.

    transaction object

    Схема Payment Order Transaction Dto.

    iduuid

    ID.

    Пример: 11111111-1111-4111-8111-111111111111
    statusstring

    Статус.

    Возможные значения: [PENDING, COMPLETED, CANCELED, REFUNDED]

    Пример: COMPLETED
    senderAmountnumber

    Сумма отправителя.

    Пример: 10.25
    senderCurrencystring

    Валюта отправителя.

    Возможные значения: [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

    Пример: USD
    receiverAmountnumber

    Сумма получателя.

    Пример: 10.25
    receiverCurrencystring

    Валюта получателя.

    Возможные значения: [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

    Пример: USD
    createddate-time

    Время создания.

    completeddate-time

    Время завершения.

    canceleddate-time

    Время отмены.

    notestring

    Примечание.

    Пример: Sandbox transfer note
    srcWalletIdstring

    ID кошелька отправителя.

    Пример: USD880390848110
    buyerEmailstring

    Email покупателя.

    Пример: [email protected]
    invoice object

    Схема Payment Order Invoice Dto.

    createddate-time

    Время создания.

    receiveddate-time

    Время получения.

    completeddate-time

    Время завершения.

    refundRequesteddate-time

    Время запроса возврата.

    refundeddate-time

    Время возврата.

    externalStatusstring

    Внешний статус.

    Возможные значения: [NEW, EXPIRED, PAYMENT_RECEIVED, UNDERPAYMENT_RECEIVED, OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_RECEIVED, EXPIRED_UNDERPAYMENT_RECEIVED, EXPIRED_OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_REFUND_REQUESTED, UNDERPAYMENT_REFUND_REQUESTED, EXPIRED_UNDERPAYMENT_REFUND_REQUESTED, OVERPAYMENT_REFUND_REQUESTED, FULL_OVERPAYMENT_REFUND_REQUESTED, EXPIRED_PAYMENT_REFUNDED, UNDERPAYMENT_REFUNDED, OVERPAYMENT_REFUNDED, FULL_OVERPAYMENT_REFUNDED, EXPIRED_PAYMENT_REFUND_CONFIRMATION_REQUIRED, UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, EXPIRED_UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, FULL_OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, CLOSED]

    Пример: NEW
    invoiceStatusstring

    Статус инвойса.

    Возможные значения: [NEW, RECEIVED, EXCHANGING, COMPLETED, REFUND_CONFIRMATION, REFUND_REQUESTED, REFUNDED, CLOSED]

    Пример: NEW
    penaltiesstring[]

    Штрафные отметки.

    Возможные значения: [EXPIRED, UNDERPAYMENT, OVERPAYMENT]

    Пример: ["EXPIRED"]
    refundTypestring

    Тип возврата.

    Возможные значения: [FULL_REFUND, PARTIAL_REFUND]

    Пример: FULL_REFUND
    cryptoCurrencyAddressstring

    Криптовалютный адрес.

    Пример: USD
    initialSenderAmountnumber

    Исходная сумма отправителя.

    Пример: 10.25
    actualReceivedAmountnumber

    Фактически полученная сумма.

    Пример: 10.25
    senderCurrencystring

    Валюта отправителя.

    Возможные значения: [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

    Пример: USD
    cryptoCurrencyTransactionIdstring

    ID криптовалютной транзакции.

    Пример: 11111111-1111-4111-8111-111111111111
    refundAddressstring

    Адрес для возврата.

    Пример: test-value