Ödeme siparişi sorgulama

GET 
/api/orders

Üye işyeri sipariş ID’sine ve isteğe bağlı SCI adına göre SCI ödeme siparişi bilgilerini döndürür.

İstek

Query parametreleri

orderId stringzorunlu
Olası değerler: <= 64 karakter
Üye işyeri sipariş tanımlayıcısı.
Örnek: test-order-001
sciName string
SCI entegrasyon adı, isteğe bağlı.
Örnek: sandbox-sci

Yanıtlar

200

OK

application/json

Şema

Şema

orderIdstring
Sipariş ID’si.
Örnek: ORDER_123456
sciNamestring
SCI adı.
Örnek: test-value
paymentStatusstring
Ödeme durumu.
Olası değerler: [PENDING, COMPLETED, CANCELED, REFUNDED]
Örnek: COMPLETED
paymentMethodstring
Ödeme yöntemi.
Olası değerler: [INTERNAL_OTHERS, CRYPTO_INVOICE]
Örnek: CRYPTO_INVOICE
paymentCreateddate-time

Ödemenin oluşturulma zamanı.

transaction object
Payment Order Transaction Dto şeması.
iduuid
ID.
Örnek: 11111111-1111-4111-8111-111111111111
statusstring
Durum.
Olası değerler: [PENDING, COMPLETED, CANCELED, REFUNDED]
Örnek: COMPLETED
senderAmountnumber
Gönderen tutarı.
Örnek: 10.25
senderCurrencystring
Gönderen para birimi.
Olası değerler: [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]
Örnek: USD
receiverAmountnumber
Alıcı tutarı.
Örnek: 10.25
receiverCurrencystring
Alıcı para birimi.
Olası değerler: [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]
Örnek: USD
createddate-time
Oluşturulma zamanı.
completeddate-time
Tamamlanma zamanı.
canceleddate-time
İptal zamanı.
notestring
Not.
Örnek: Sandbox transfer note
srcWalletIdstring
Kaynak cüzdan ID’si.
Örnek: USD880390848110
buyerEmailstring
Alıcı e-postası.
Örnek: [email protected]
invoice object
Payment Order Invoice Dto şeması.
createddate-time
Oluşturulma zamanı.
receiveddate-time
Alınma zamanı.
completeddate-time
Tamamlanma zamanı.
refundRequesteddate-time
İade talep zamanı.
refundeddate-time
İade zamanı.
externalStatusstring
Harici durum.
Olası değerler: [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]
Örnek: NEW
invoiceStatusstring
Fatura durumu.
Olası değerler: [NEW, RECEIVED, EXCHANGING, COMPLETED, REFUND_CONFIRMATION, REFUND_REQUESTED, REFUNDED, CLOSED]
Örnek: NEW
penaltiesstring[]
Ceza işaretleri.
Olası değerler: [EXPIRED, UNDERPAYMENT, OVERPAYMENT]
Örnek: ["EXPIRED"]
refundTypestring
İade türü.
Olası değerler: [FULL_REFUND, PARTIAL_REFUND]
Örnek: FULL_REFUND
cryptoCurrencyAddressstring
Kripto adresi.
Örnek: USD
initialSenderAmountnumber
Gönderenin ilk tutarı.
Örnek: 10.25
actualReceivedAmountnumber
Fiilen alınan tutar.
Örnek: 10.25
senderCurrencystring
Gönderen para birimi.
Olası değerler: [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]
Örnek: USD
cryptoCurrencyTransactionIdstring
Kripto işlem ID’si.
Örnek: 11111111-1111-4111-8111-111111111111
refundAddressstring
İade adresi.
Örnek: test-value

Örnek

{
  "orderId": "ORDER_123456",
  "sciName": "test-value",
  "paymentStatus": "CREATED",
  "paymentMethod": "CRYPTO_INVOICE",
  "paymentCreated": "2026-01-15T10:30:00",
  "transaction": {
    "status": "success"
  },
  "invoice": {
    "status": "success"
  }
}

400

Hatalı istek. İstek hatalı biçimlendirilmiş veya geçersiz parametreler içeriyor.

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: disabled
errorTypestringzorunlu
Hata kategorisi.
Örnek: FORM
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Yetkisiz. Üye işyeri kimlik doğrulama başlıkları eksik veya geçersiz.

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: userDoesNotExistException
errorTypestringzorunlu
Hata kategorisi.
Örnek: GENERAL
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Bulunamadı. İstenen kaynak mevcut değil.

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: resourceNotFound
errorTypestringzorunlu
Hata kategorisi.
Örnek: GENERAL
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: Resource not found
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Sunucu iç hatası. Beklenmeyen hata, lütfen destek ekibiyle iletişime geçin

application/json

Şema

Şema

statusstringzorunlu
Yanıt durumu.
Olası değerler: [error]
Örnek: error
data objectzorunlu
Hata yanıtı verileri.
errors object[]zorunlu
İstek için döndürülen hataların listesi.
Array [
errorMessagestringzorunlu
Değişmeyen, makine tarafından okunabilir hata kodu.
Örnek: internalServerError
errorTypestringzorunlu
Hata kategorisi.
Örnek: GENERAL
errorIdstringzorunlu
Destek ve günlükler için kısa, benzersiz hata tanımlayıcısı.
Örnek: errTest1234
errorDescriptionstringzorunlu
Okunabilir hata açıklaması.
Örnek: Internal server error
errorFieldstringnullable
Varsa hatayla ilgili istek alanı.
Örnek: null
paramsobject[]zorunlu
Ek hata parametreleri.
requestParamsobjectzorunlu
Tanılama için kaydedilen istek parametreleri.
]

Örnek

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}