Get payment order

GET 
/api/orders

Returns Hosted Checkout payment order information by merchant order ID and optional Hosted Checkout name.

Request

Query Parameters

orderId stringrequired
Possible values: <= 64 characters
Merchant order identifier.
Example: test-order-001
sciName string
Hosted Checkout name set in your Volet.com account.
Example: sandbox-sci

Responses

200

OK

application/json

Schema

Schema

orderIdstring
Order Id.
Example: ORDER_123456
sciNamestring
Hosted Checkout name set in your Volet.com account.
Example: test-value
paymentStatusstring
Payment Status.
Possible values: [PENDING, COMPLETED, CANCELED, REFUNDED]
Example: COMPLETED
paymentMethodstring
Payment Method.
Possible values: [INTERNAL_OTHERS, CRYPTO_INVOICE]
Example: CRYPTO_INVOICE
paymentCreateddate-time

Payment Created.

transaction object
Payment Order Transaction Dto schema.
iduuid
Id.
Example: 11111111-1111-4111-8111-111111111111
statusstring
Status.
Possible values: [PENDING, COMPLETED, CANCELED, REFUNDED]
Example: COMPLETED
senderAmountnumber
Sender Amount.
Example: 10.25
senderCurrencystring
Sender Currency.
Possible values: [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]
Example: USD
receiverAmountnumber
Receiver Amount.
Example: 10.25
receiverCurrencystring
Receiver Currency.
Possible values: [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]
Example: USD
createddate-time
Created.
completeddate-time
Completed.
canceleddate-time
Canceled.
notestring
Note.
Example: Sandbox transfer note
srcWalletIdstring
Src Wallet Id.
Example: USD880390848110
buyerEmailstring
Buyer Email.
Example: [email protected]
invoice object
Payment Order Invoice Dto schema.
createddate-time
Created.
receiveddate-time
Received.
completeddate-time
Completed.
refundRequesteddate-time
Refund Requested.
refundeddate-time
Refunded.
externalStatusstring
External Status.
Possible values: [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]
Example: NEW
invoiceStatusstring
Invoice Status.
Possible values: [NEW, RECEIVED, EXCHANGING, COMPLETED, REFUND_CONFIRMATION, REFUND_REQUESTED, REFUNDED, CLOSED]
Example: NEW
penaltiesstring[]
Penalties.
Possible values: [EXPIRED, UNDERPAYMENT, OVERPAYMENT]
Example: ["EXPIRED"]
refundTypestring
Refund Type.
Possible values: [FULL_REFUND, PARTIAL_REFUND]
Example: FULL_REFUND
cryptoCurrencyAddressstring
Crypto Currency Address.
Example: USD
initialSenderAmountnumber
Initial Sender Amount.
Example: 10.25
actualReceivedAmountnumber
Actual Received Amount.
Example: 10.25
senderCurrencystring
Sender Currency.
Possible values: [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]
Example: USD
cryptoCurrencyTransactionIdstring
Crypto Currency Transaction Id.
Example: 11111111-1111-4111-8111-111111111111
refundAddressstring
Refund Address.
Example: test-value

Example

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

400

Bad request. The request is malformed or contains invalid parameters.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: disabled
errorTypestringrequired
Error category.
Example: FORM
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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

401

Unauthorized. Merchant authentication headers are missing or invalid.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: userDoesNotExistException
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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

404

Not found. The requested resource does not exist.

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: resourceNotFound
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Resource not found
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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

500

Internal server error. Unexpected error please contact support

application/json

Schema

Schema

statusstringrequired
Response status.
Possible values: [error]
Example: error
data objectrequired
Error response payload.
errors object[]required
List of errors returned for the request.
Array [
errorMessagestringrequired
Stable machine-readable error code.
Example: internalServerError
errorTypestringrequired
Error category.
Example: GENERAL
errorIdstringrequired
Short unique error identifier for support and logs.
Example: errTest1234
errorDescriptionstringrequired
Human-readable error description.
Example: Internal server error
errorFieldstringnullable
Request field related to the error, if any.
Example: null
paramsobject[]required
Additional error parameters.
requestParamsobjectrequired
Request parameters captured for diagnostics.
]

Example

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