---
title: "Get order details"
method: POST
path: "/order/details/{orderId}"
tags: ["Order Service"]
---

# Get order details

`POST /order/details/{orderId}`

Retrieves order details for the specified orderId.

## Path parameters

- `orderId` integer, required

## Response `200`

Order details retrieved successfully.

- Order — Order details returned for an orderId.
  - `orderId` integer — Unique identifier of the order.
  - `orderDate` string, date-time — Date and time when the order was created.
  - `authorizeAmount` number — Total authorized amount for the order.
  - `paymentAmount` number — Total paid amount for the order.
  - `refundAmount` number — Total refunded amount for the order.
  - `refundBalance` number — Remaining refundable balance for the order.
  - `status` string — Current status of the order.
  - `paymentItems` OrderItem[] — List of payment items associated with the order.
    - `itemId` integer — Unique identifier of the item.
    - `itemKey` string — Unique key of the item.
    - `name` string — Display name of the item.
    - `description` string — Description of the item.
    - `orderItemId` integer — Unique identifier of the item entry within the order.
    - `sku` string — SKU value for the item.
    - `instanceId` string — Instance identifier for the item.
    - `type` 'INVALID' | 'GENERAL' | 'TAX' | 'FEE' | 'DISCOUNT' | 'ENGINE' — Type classification of the item.
    - `authorizeAmount` number — Authorized amount for the item.
    - `paymentAmount` number — Paid amount for the item.
    - `refundAmount` number — Refunded amount for the item.
    - `refundBalance` number — Remaining refundable balance for the item.
    - `attributes` ItemAttribute[] — Additional attributes for the item.
      - `receiptDisplay` boolean — Determines whether or not the attribute is displayed on the receipt
      - `attribute` string — Attribute name
      - `value` string — Attribute value
  - `feeItems` OrderItem[] — List of fee items associated with the order.
    - `itemId` integer — Unique identifier of the item.
    - `itemKey` string — Unique key of the item.
    - `name` string — Display name of the item.
    - `description` string — Description of the item.
    - `orderItemId` integer — Unique identifier of the item entry within the order.
    - `sku` string — SKU value for the item.
    - `instanceId` string — Instance identifier for the item.
    - `type` 'INVALID' | 'GENERAL' | 'TAX' | 'FEE' | 'DISCOUNT' | 'ENGINE' — Type classification of the item.
    - `authorizeAmount` number — Authorized amount for the item.
    - `paymentAmount` number — Paid amount for the item.
    - `refundAmount` number — Refunded amount for the item.
    - `refundBalance` number — Remaining refundable balance for the item.
    - `attributes` ItemAttribute[] — Additional attributes for the item.
      - `receiptDisplay` boolean — Determines whether or not the attribute is displayed on the receipt
      - `attribute` string — Attribute name
      - `value` string — Attribute value
  - `customer` Customer — Customer information.
    - `username` string — Username
    - `phone` string — Primary phone number
    - `phone2` string — Secondary phone number
    - `company` string — Company name
    - `email` string — Email address
    - `fax` string — Fax number
    - `firstName` string — First name
    - `lastName` string — Last name
    - `middleName` string — Middle name
    - `ip` string — IP address
    - `deviceFingerprint` string — Device fingerprint
    - `identities` CustomerIdentity[] — Extra identity information needed when grand total is $3000 or more
      - `identityTypeId` 0 | 1 | 2 | 3 | 4, required — Valid values: 1=SSN, 2=Passport, 4=Alien Registration Number for Identity One; 0=Other, 3=Driver’s License for Identity Two
      - `value` string, required — The identity's value
      - `countryCode` string, required — Country code
      - `region` string — (optional for SSN, Passport, and Alien Registration Number; required for Driver's license and Other)Region/state code
    - `employer` boolean — Indicates whether or not you are an employer
    - `employerFein` string — Employer FEIN
  - `paymentInfo` OrderPaymentInfo — Details about the payment instrument used to complete the order.
    - `paymentMethod` 'Unkown' | 'CreditCard' | 'BankAccount' | 'BillingAccount' | 'ApplePay' | 'GooglePay' | 'PayPal' | 'WeChat' | 'AliPay' | 'PointOfSale' | 'Venmo' | 'Cash' — Payment method used in the order.
    - `cardHolderName` string — Card holder name when payment is made by card.
    - `cardSummary` string — Masked card number summary shown to the customer.
    - `cardType` string — Card brand or type, for example Visa or MasterCard.
    - `expiryDate` string — Card expiration date in display format.
    - `bankAccountSummary` string — Masked bank account summary when payment is made by bank account.
    - `bankAccountName` string — Name on the bank account used for payment.
  - `subscriptionId` string — Subscription identifier associated with this order, when applicable.

## Other responses

- `401` — Unauthorized. The access token is missing, invalid, or expired.
- `404` — Order not found
- `500` — Internal server error

---

[API](https://skmtc.dev/civikestpayment/apis/pays-service-api-specifications.md) · [All operations](https://skmtc.dev/civikestpayment/apis/pays-service-api-specifications/llms.txt) · [OpenAPI document](https://skmtc.dev/civikestpayment/apis/pays-service-api-specifications/revisions/e94a116dff94?raw)