---
title: "GET /payment-api/v1/order/{transactionId}"
method: GET
path: "/payment-api/v1/order/{transactionId}"
tags: ["Order"]
---

# GET /payment-api/v1/order/{transactionId}

`GET /payment-api/v1/order/{transactionId}`

## Path parameters

- `transactionId` string, required

## Response `200`

Success

- OrderGetModel
  - `id` integer
  - `transactionId` string, nullable
  - `statusId` 'FuturePayment' | 'PartiallyPaid' | 'Paid' | 'PartiallyRefunded' | 'Refunded' | 'Cancelled' | 'CancelledWithPayments' | 'CancelledAndRefunded' | 'PendingPayment' | 'UserActionRequired' | 'LinkExpired' | 'VCCPayment' | 'Tokenized' | 'Disputed' | 'Voided'
  - `sourceType` 'None' | 'Ows' | 'Cendyn' | 'Oracle'
  - `payerDetails` OrderPayerDetailsItemGetModel
    - `customerId` integer
    - `payerTitle` string, nullable
    - `payerName` string, nullable
    - `payerEmail` string, nullable
    - `payerCountry` string, nullable
    - `payerPhone` string, nullable
  - `travelerDetails` OrderTravelerDetailsItemGetModel
    - `travelerName` string, nullable
    - `travelerEmail` string, nullable
    - `travelerAddress` string, nullable
    - `travelerCity` string, nullable
    - `travelerTitle` string, nullable
    - `travelerPhone` string, nullable
  - `paymentDetails` OrderPaymentDetailsItemGetModel
    - `referenceNo` string, nullable
    - `currency` string, nullable
    - `country` string, nullable
    - `amount` number, double
    - `orderDate` string, date-time
    - `status` 'FuturePayment' | 'PartiallyPaid' | 'Paid' | 'PartiallyRefunded' | 'Refunded' | 'Cancelled' | 'CancelledWithPayments' | 'CancelledAndRefunded' | 'PendingPayment' | 'UserActionRequired' | 'LinkExpired' | 'VCCPayment' | 'Tokenized' | 'Disputed' | 'Voided'
    - `description` string, nullable
    - `serviceDate` string, date-time, nullable
    - `paymentDate` string, date-time, nullable
    - `cancelDate` string, date-time, nullable
    - `mode` 'Payment' | 'PayLater' | 'Token' | 'Terminal' | 'Authorize'
    - `statementSuffix` string, nullable
    - `imageLink` string, nullable
    - `submitLabel` string, nullable
    - `orderFor` string, nullable
    - `isVcc` boolean
    - `pmsPosting` boolean
    - `pmsPosted` boolean
    - `pmsPostedDate` string, date-time, nullable
    - `pmsPostingProcessed` boolean
    - `pmsRefundPostingProcessed` boolean
    - `pmsRefundPosted` boolean
    - `merchantId` integer
    - `metadata` object, nullable
    - `paymentSchedule` ScheduledPaymentItemGetModel[], nullable
      - `id` integer
      - `label` string, nullable
      - `dateTime` string, date-time
      - `amountInOrderCurrency` number, double, nullable
      - `currencyToPay` string, nullable
      - `amountInCurrencyToPay` number, double, nullable
      - `exchangeRate` number, double, nullable
      - `status` 'Pending' | 'Paid' | 'Failed' | 'Cancelled' | 'Refunded'
      - `orderItemId` integer
    - `lineItems` OrderLineItemGetModel[], nullable
      - `id` integer
      - `itemRef` string, nullable
      - `currency` string, nullable
      - `amount` number, double
      - `description` string, nullable
      - `productCode` string, nullable
      - `tax` number, double
      - `amountAfterTax` number, double
      - `pmsReferenceNo` string, nullable
      - `crsReferenceNo` string, nullable
      - `mealType` string, nullable
      - `roomType` string, nullable
      - `ratePlanCode` string, nullable
      - `transactionTypeId` integer
      - `checkInDate` string, date-time, nullable
      - `checkOutDate` string, date-time, nullable
      - `pmsPosted` boolean
      - `pmsPostedDate` string, date-time, nullable
      - `pmsPostingProcessed` boolean
      - `metadata` object, nullable
    - `payments` OrderPaymentItemGetModel[], nullable
      - `id` integer
      - `scheduledPaymentId` integer, nullable
      - `currencyIso` string, nullable
      - `amount` number, double
      - `netAmount` number, double
      - `paymentCurrencyIso` string, nullable
      - `paymentAmount` number, double
      - `exchangeRate` number, double, nullable
      - `feePercAmount` number, double, nullable
      - `paymentProcessedDate` string, date-time
      - `payoutAvailableDate` string, date-time, nullable
      - `status` 'RequiresPaymentMethod' | 'RequiresConfirmation' | 'RequiresAction' | 'Processing' | 'RequiresCapture' | 'Canceled' | 'Succeeded' | 'Scheduled' | 'PartialRefund' | 'Refund' | 'DisputedNeedsResponse' | 'DisputedUnderReview' | 'DisputedChargeRefunded' | 'DisputedWon' | 'DisputedLost' | 'DisputedCanceled' | 'DisputedExpired' | 'DisputedWarningClosed' | 'DisputedAccepted' | 'DisputedArbitrationSentToScheme' | 'DisputedEvidenceAcknowledgedByScheme' | 'DisputedEvidenceSubmitted' | 'DisputedResolved' | 'Voided' | 'DisputedEvidenceRequired' | 'DisputedArbitrationEvidenceSubmitted' | 'DisputedArbitrationWon' | 'DisputedArbitrationLost'
      - `externalId` string, nullable
      - `varianceAmount` number, double, nullable
      - `autoConverted` boolean, nullable
      - `type` 0 | 1 | 2 | 3 | 4
      - `isDirect` boolean
      - `authCode` string, nullable
      - `paymentMethod` OrderPaymentMethodItemGetModel
        - `type` string, nullable
        - `brand` string, nullable
        - `brandProductCode` string, nullable
        - `issueCountry` string, nullable
        - `description` string, nullable
        - `last4` string, nullable
        - `expMonth` integer
        - `expYear` integer
      - `fees` OrderPaymentFeeItemGetModel[], nullable
        - `feeType` 'DM' | 'IN' | 'FX' | 'APM' | 'RF' | 'FX_NSC' | 'AC' | 'Monthly' | 'Dispute' | 'Remittance' | 'PayoutFXC' | 'PayoutFXFee'
        - `fixedValue` number, double
        - `variableValue` number, double
      - `failures` OrderPaymentFailDetailsItemGetModel[], nullable
        - `code` string, nullable
        - `message` string, nullable
        - `networkStatus` string, nullable
        - `reason` string, nullable
        - `riskLevel` string, nullable
        - `sellerMessage` string, nullable
        - `type` string, nullable
        - `dateTime` string, date-time
        - `amount` number, double, nullable
        - `currency` string, nullable
        - `paymentMethod` OrderPaymentMethodItemGetModel
          - `type` string, nullable
          - `brand` string, nullable
          - `brandProductCode` string, nullable
          - `issueCountry` string, nullable
          - `description` string, nullable
          - `last4` string, nullable
          - `expMonth` integer
          - `expYear` integer
      - `refunds` OrderPaymentRefundItemGetModel[], nullable
        - `id` integer
        - `externalId` string, nullable
        - `paymentIntentId` integer
        - `orderId` integer
        - `status` 'Pending' | 'Succeeded' | 'Failed' | 'Canceled'
        - `created` string, date-time
        - `amount` number, double
        - `currency` string, nullable
        - `requestedAmount` number, double
        - `requestedCurrency` string, nullable
        - `usAmountRequested` number, double
        - `usAmountRefunded` number, double
        - `createUserId` string, uuid, nullable
        - `createdUserName` string, nullable
        - `scheduledPaymentId` integer, nullable
        - `orderItemId` integer, nullable
    - `paymentLinks` OrderPaymentLinkItemGetModel[], nullable
      - `id` integer
      - `paymentIntentId` integer
      - `paymentLink` string, nullable
      - `paymentLinkKey` string, nullable
      - `encryptedPubKey` string, nullable
      - `expiryDate` string, date-time
      - `createDate` string, date-time
  - `hotelDetails` OrderHotelItemGetModel
    - `hotelName` string, nullable
    - `roomType` string, nullable
    - `mealType` string, nullable
    - `checkInDate` string, date-time
    - `checkOutDate` string, date-time
    - `ratePlanCode` string, nullable
    - `ratePlanDescription` string, nullable
    - `notes` string, nullable
  - `createdUserDetail` OrderCreatedUserDetailGetModel
    - `userId` string, nullable
    - `merchantId` integer
    - `merchantName` string, nullable
    - `userApiKey` string, nullable
  - `returnUrlSuccess` string, nullable
  - `returnUrlCancel` string, nullable
  - `webhookUrl` string, nullable
  - `language` string, nullable
  - `createdBy` string, nullable
  - `merchantName` string, nullable
  - `merchantGroupId` integer

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `500` — Server Error

---

[API](https://skmtc.dev/iolpay/apis/iolpay-payment-api-public.md) · [All operations](https://skmtc.dev/iolpay/apis/iolpay-payment-api-public/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/iolpay/iolpay-payment-api-public/revisions/f14fdc43700a/schema)