---
title: "Get order"
method: GET
path: "/orders/{order_id}"
tags: ["Payments"]
---

# Get order

`GET /orders/{order_id}`

Get information about an order.

## Path parameters

- `order_id` string, required

## Response `200`

Request successful

- object
  - `success` Success — unresolved $ref
  - `data` object — Information about the order. The structure of the response may differ depending on the order type and payment method.
    - `amount` Amount — unresolved $ref
    - `amount_refunded` integer — The amount refunded to the customer.
    - `auth_order_id` string — Your unique identifier for the manual capture order.
    - `completed_date` string — The timestamp for when the order was completed. **Format:** [ISO 8601 time](https://en.wikipedia.org/wiki/ISO_8601).
    - `costs` object — The fees for the transaction.
      - `transaction_id` Schema — unresolved $ref
      - `amount` number — The payment amount in decimal form, e.g. 0.16 EUR is 16 cents.
      - `description` string — A description of the transaction.
      - `type` 'SYSTEM' | 'internal'
      - `created` Created — unresolved $ref
      - `status` Status — unresolved $ref
    - `created` Created — unresolved $ref
    - `currency` Currency — unresolved $ref
    - `customer` object — The customer’s personal information.
      - `locale` 'cs_CZ' | 'de_AT' | 'de_DE' | 'en_US' | 'fi_FI' | 'fr_BE' | 'fr_FR' | 'it_IT' | 'nl_BE' | 'nl_NL' | 'pl_PL' | 'es_ES' | 'sv_SE' | 'zh_CN', ab_CD with ISO 639 language codes and ISO 3166 country codes — - Localizes [payment pages](https://docs.multisafepay.com/docs/payment-pages/) for the customer’s language, region, UI preferences, and available payment methods or local variants. - Sends [email templates](https://docs.multisafepay.com/docs/email-styling/) in the customer's preferred language. **Format:** ab_CD with [ISO 639 language codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) and [ISO 3166 country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). |Locale|Language & country| |--------|--------| |`cs_CZ`|Czech | |`de_AT`|German (Austria)| |`de_DE`|German (Germany)| |`en_US`|American English| |`fi_FI`|Finnish| |`fr_BE`|French (Belgium)| |`fr_FR`|French (France)| |`it_IT`|Italian| |`nl_BE`|Dutch (Belgium)| |`nl_NL`|Dutch (Netherlands)| |`pl_PL`|Polish| |`es_ES`|Spanish| |`sv_SE`|Swedish| |`zh_CN`|Chinese|
      - `first_name` FirstName — unresolved $ref
      - `last_name` LastName — unresolved $ref
      - `address1` Address1 — unresolved $ref
      - `address2` Address2 — unresolved $ref
      - `house_number` string — The house number of the address. **Required for:** Amazon Pay, Klarna, and Billink
      - `zip_code` Zipcode — unresolved $ref
      - `city` City — unresolved $ref
      - `state` string — The state of the address. **Required for:** PayPal Seller Protection
      - `company_name` CompanyName — unresolved $ref
      - `coc_number` CocNumber — unresolved $ref
      - `country` string, country alpha-2 — The country of the address. **Format:** [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). **Required for:** Bank Transfer, cards, and PayPal Seller Protection
      - `country_name` string — The full name of the country.
      - `phone` Phone — unresolved $ref
      - `email` string — The customer’s email address. Used for [Second Chance](https://docs.multisafepay.com/docs/second-chance/) emails and fraud checks.
      - `reference` string — Your unique client-defined identifier for your customer. **Required for:** [Recurring payments](https://docs.multisafepay.com/docs/recurring-payments/) orders, both initial and subsequent payments.
    - `description` Description — unresolved $ref
    - `fastcheckout` string — Whether the order was processed using FastCheckout.
    - `financial_status` FinancialStatus — unresolved $ref
    - `items` string — Displays additional information on payment pages and in payment confirmation emails to customers using HTML, e.g. display order items instead of including a `shopping_cart`. For information about supported HTML tags and elements, see Payment pages - [Styling](https://docs.multisafepay.com/docs/payment-pages#styling).
    - `modified` Updated — unresolved $ref
    - `order_id` OrderId — unresolved $ref
    - `payment_details` object — Information about the payment.
      - `account_bic` Bic — unresolved $ref
      - `account_holder_name` string — The name of the account holder to be charged for the transaction.
      - `account_iban` string, iban — The customer's international bank account number (IBAN). IBANs are sensitive data. For security reasons, we mask them by default so that only the last 4 digits are visible, e.g. *** 1234. To unmask IBANs, see [IBANs](https://docs.multisafepay.com/docs/ibans).
      - `account_id` Iban — unresolved $ref
      - `application_id` string — The unique code in a payment card chip that tells the terminal which type of card it is and which payment network to use.
      - `authorization_code` integer — The unique identifier provided by the scheme.
      - `card_acceptor_id` integer — The merchant's unique identifier.
      - `card_acceptor_location` string — The merchant's location.
      - `card_acceptor_name` string — The merchant's name.
      - `card_additional_response_data` object — Additional data returned by the card scheme, related to the transaction's authentication process.
        - `cavv_results_code` string — The Cardholder Authentication Verification Value confirmation code.
        - `sca_details` object — The information realted to the Strong Customer Authentication (SCA) process.
          - `tra_exempltion_indicator` string — Indicates whether the transaction is exempt from SCA.
      - `card_authentication_details` object — The information about the 3DS authentication method.
        - `flow` string — The 3DS authentication flow. The value is determined by the card scheme and the authentication method used. Possible values include `challenge`, `frictionless` and `exemption`.
        - `exemption` string — The type of SCA exemption applied to the transaction, if any.
      - `card_authentication_result` object — The information about the outcome of the card authentication process.
        - `acs_transaction_id` string — The unique identifier for the transaction at the Access Control Server (ACS) of the issuing bank. The ACS is responsible for authenticating the cardholder.
        - `challenge_cancel` string — Indicates whether the challenge was canceled.
        - `cavv` string — The Cardholder Authentication Verification Value, a cryptographic value generated during the authentication process.
        - `ds_transaction_id` string — The unique identifier for the transaction at the Directory Server (DS) of the issuing bank. The DS is responsible for routing the authentication request to the appropriate ACS.
        - `eci` string — The Electronic Commerce Indicator (ECI) code indicates the outcome of the authentication process.
        - `status` string — The 3D Secure status code that indicates the outcome of the authentication process. Possible values include: - `Y`: Authentication successful. - `A`: Authentication attempted. - `C`: Challenge required. - `N`: Authentication failed. - `U`: Authentication could not be performed. - `R`: Authentication rejected.
        - `transaction_status_reason` string — The reason code for a failed authentication.
        - `version` string — The version of the 3D Secure protocol used for the authentication.
      - `car_entry_mode` 'ICC' | 'ICC_CONTACTLESS' | 'MAGSTRIPE' — The method for capturing card payment information during a payment.
      - `card_expiry_date` ExpiryDate — unresolved $ref
      - `card_funding` 'C' | 'D' | 'P' | 'R' — The type of card used. Possible values: - Credit card, set to `C`. - Debit card, set to `D`. - Prepaid card, set to `P`. - Deferred debit card, set to `R`. - Charge card, set to `H`.
      - `card_product` string — The name used by the card scheme to classify products within different programs.
      - `card_product_type` 0 | 1 | 2 | 3 — The type of card processed. Possible values: - Unknown, set to `0`. - Consumer, set to `1`. - Commercial, set to `2`. - All, set to `3`.
      - `card_program` string — An acronym used by the card scheme to categorize cards by their funding properties.
      - `card_sequence_number` string — A unique identifier assigned to each card to differentiate it from other cards issued under the same primary account number (PAN).
      - `cardholder_verification_method` string — The card verification method (CVM).
      - `cardholder_verification_result` string — The outcome of the cardholder verification method.
      - `external_transaction_id` integer — The order reference number of a third party, e.g. the payment method.
      - `issuer_bin` string — The issuer BIN (Bank Identification Number). **Format**: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
      - `issuer_country_code` string — The country code of the card's issuing bank.
      - `last4` Last4 — unresolved $ref
      - `mcc` string — The Merchant Category Code. A four-digit number that classifies the merchant's business type.
      - `recurring_flow` 'manual' | 'token' — The method used to store your card details.
      - `recurring_id` string — The unique identifier of the recurring payment. **Required** for: Subsequent [recurring payments](https://docs.multisafepay.com/docs/recurring-payments).
      - `recurring_model` Model — unresolved $ref
      - `response_code` integer — The response status code.
      - `terminal_id` Id — unresolved $ref
      - `scheme_reference_id` string — The unique identifier assigned by the card scheme to this authentication transaction, used for tracking and reconciliation across all parties.
      - `type` string — The payment method.
    - `payment_methods` object[]
      - `account_bic` Bic — unresolved $ref
      - `account_holder_name` string — The name of the account holder.
      - `account_iban` AccountIban — unresolved $ref
      - `amount` Amount — unresolved $ref
      - `card_expiry_date` ExpiryDate — unresolved $ref
      - `currency` Currency — unresolved $ref
      - `description` Description — unresolved $ref
      - `external_transaction_id` ExternalTransactionId — unresolved $ref
      - `last4` Last4 — unresolved $ref
      - `payment_description` string — The payment method.
      - `status` Status — unresolved $ref
      - `type` string — The payment gateway.
    - `reason` string — The reason for any updates to the order.
    - `reason_code` string — The code for the reason for any updates to the order.
    - `related_transactions` object[]
      - `amount` Amount — unresolved $ref
      - `costs` object — The fees for the transaction.
        - `amount` Amount — unresolved $ref
        - `description` Description — unresolved $ref
        - `type` 'SYSTEM' | 'internal'
        - `currency` Currency — unresolved $ref
        - `status` Status — unresolved $ref
      - `created` Created — unresolved $ref
      - `currency` Currency — unresolved $ref
      - `description` Description — unresolved $ref
      - `dispute` Dispute — unresolved $ref
      - `modified` Updated — unresolved $ref
      - `order_id` OrderId — unresolved $ref
      - `reference_transaction_id` Schema — unresolved $ref
      - `refund_order_id` string — Set a unique identifier for the refund order ID.
      - `status` Status — unresolved $ref
      - `transaction_id` integer — MultiSafepay's unique identifier for the related transactions.
      - `type` 'capture' | 'chargeback' | 'reverse-chargeback' | 'refund' | 'auth-cancellation'
    - `status` Status — unresolved $ref
    - `tip` object — The serial number of the terminal.
      - `amount` integer — The total amount tipped.
    - `transaction_id` Schema — unresolved $ref
    - `var1` Var1 — unresolved $ref
    - `var2` Var1 — unresolved $ref
    - `var3` Var3 — unresolved $ref

## Other responses

- `404` — Order not found

---

[API](https://skmtc.dev/multisafepay/apis/multisafepay-banking-order-api.md) · [All operations](https://skmtc.dev/multisafepay/apis/multisafepay-banking-order-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/multisafepay/multisafepay-banking-order-api/revisions/ce9612e4a307/schema)