Adyen Transactionstatus API

The Transactionstatus API from Adyen — 1 operation(s) for transactionstatus.

Documentation

📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
📖
Documentation
https://docs.adyen.com/api-explorer/Account/6/overview
📖
Documentation
https://docs.adyen.com/development-resources/webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/BalanceControl/1/overview
📖
Documentation
https://docs.adyen.com/api-explorer/BinLookup/52/overview
📖
Documentation
https://docs.adyen.com/api-explorer/Checkout/71/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform/2/overview
📖
Documentation
https://docs.adyen.com/api-explorer/balanceplatform-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/development-resources/data-protection-api/
📖
Documentation
https://docs.adyen.com/risk-management/disputes-api
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/fund-transfer/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted/
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/legal-entity-management-api/
📖
Documentation
https://docs.adyen.com/api-explorer/Management/3/overview
📖
Documentation
https://docs.adyen.com/api-explorer/management-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/classic/notifications
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/notifications/
📖
Documentation
https://docs.adyen.com/online-payments/
📖
Documentation
https://docs.adyen.com/online-payments/online-payouts
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/
📖
Documentation
https://docs.adyen.com/online-payments/tokenization
📖
Documentation
https://docs.adyen.com/api-explorer/report-webhooks/1/overview
📖
Documentation
https://docs.adyen.com/payment-methods/gift-cards/stored-value-api/
📖
Documentation
https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/
📖
Documentation
https://docs.adyen.com/development-resources/testing/create-test-cards
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/business-accounts/transactions/transaction-webhooks/
📖
Documentation
https://docs.adyen.com/api-explorer/transfer-webhooks/3/overview
📖
Documentation
https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/on-demand-payouts
📖
Documentation
https://docs.adyen.com/development-resources/webhooks

Specifications

Other Resources

OpenAPI Specification

adyen-transactionstatus-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account acceptDispute Transactionstatus API
  description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
  x-timestamp: '2023-05-30T15:27:20Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: Transactionstatus
paths:
  /transactionstatus:
    post:
      description: It conveys Information requested for status of the last or current Payment, Loyalty or Reversal transaction. Content of the TransactionStatus Request message.
      summary: Adyen TransactionStatus Request
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionStatusRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionStatusResponse'
              examples:
                operation200Example:
                  summary: Default operation 200 response
                  x-microcks-default: true
                  value:
                    Response: example_value
                    MessageReference: REF-001
                    RepeatedMessageResponse: example_value
          description: It conveys Information related to the status of the last or current Payment, Loyalty or Reversal transaction. Content of the TransactionStatus Response message.
      tags:
      - Transactionstatus
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CardData:
      type: object
      description: Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition  or BalanceInquiry request to the POI. It could also be sent in the CardAcquisition response, to be processed by the Sale System. Information related to the payment card used for the transaction.
      properties:
        PaymentBrand:
          type: string
          pattern: ^.+$
          description: If card PAN is readable .
        MaskedPan:
          type: string
          pattern: ^.+$
        PaymentAccountRef:
          type: string
          pattern: ^.+$
        EntryMode:
          $ref: '#/components/schemas/EntryMode'
        CardCountryCode:
          type: integer
          minimum: 3
          maximum: 3
          description: If available in the card.
        ProtectedCardData:
          type: string
          description: SensitiveCardData protected by CMS EnvelopedData.
        SensitiveCardData:
          $ref: '#/components/schemas/SensitiveCardData'
        AllowedProductCode:
          type: array
          items:
            type: integer
            minimum: 1
            maximum: 20
        AllowedProduct:
          type: array
          items:
            $ref: '#/components/schemas/AllowedProduct'
        PaymentToken:
          $ref: '#/components/schemas/PaymentToken'
        CustomerOrder:
          type: array
          items:
            $ref: '#/components/schemas/CustomerOrder'
    UTMCoordinates:
      type: object
      properties:
        UTMZone:
          type: string
          pattern: ^.+$
        UTMEastward:
          type: string
          pattern: ^.+$
        UTMNorthward:
          type: string
          pattern: ^.+$
      required:
      - UTMZone
      - UTMEastward
      - UTMNorthward
    StoredValueAccountID:
      type: object
      description: It contains the identifications of the stored value account or the stored value card, and the associated product sold by the Sale System for stored value requests. Identification of the stored value account or the stored value card.
      properties:
        StoredValueAccountType:
          $ref: '#/components/schemas/StoredValueAccountType'
        StoredValueProvider:
          type: string
          pattern: ^.+$
        OwnerName:
          type: string
          pattern: ^.+$
        ExpiryDate:
          type: integer
          minimum: 4
          maximum: 4
        EntryMode:
          $ref: '#/components/schemas/EntryMode'
        IdentificationType:
          $ref: '#/components/schemas/IdentificationType'
        StoredValueID:
          type: string
          pattern: ^.+$
      required:
      - StoredValueAccountType
      - EntryMode
      - IdentificationType
      - StoredValueID
    MessageCategory:
      type: string
      enum:
      - Abort
      - Admin
      - BalanceInquiry
      - CardAcquisition
      - CardReaderAPDU
      - Diagnosis
      - Display
      - EnableService
      - Event
      - GetTotals
      - Input
      - InputUpdate
      - Login
      - Logout
      - Loyalty
      - Payment
      - Print
      - Reconciliation
      - Reversal
      - StoredValue
      - TransactionStatus
    PeriodUnit:
      type: string
      enum:
      - Annual
      - Daily
      - Monthly
      - Weekly
    ReversalResponse:
      type: object
      description: It conveys Information related to the reversal processed by the POI System. Content of the Reversal Response message.
      properties:
        Response:
          $ref: '#/components/schemas/Response'
        POIData:
          $ref: '#/components/schemas/POIData'
        OriginalPOITransaction:
          $ref: '#/components/schemas/OriginalPOITransaction'
        ReversedAmount:
          type: number
          maximum: 99999999.999999
          minimum: 0
          description: Copy.
        CustomerOrder:
          type: array
          items:
            $ref: '#/components/schemas/CustomerOrder'
        PaymentReceipt:
          type: array
          items:
            $ref: '#/components/schemas/PaymentReceipt'
      required:
      - Response
    CustomerOrder:
      type: object
      description: Customer order attached to a customer, recorded in the POI system.  Allows the management of customer orders by the POI, for instance in a multi-channel or a click and collect sale transaction.
      properties:
        CustomerOrderID:
          type: string
          pattern: ^.+$
          description: Additional and optional identification of a customer order.
        SaleReferenceID:
          type: string
          pattern: ^.+$
        OpenOrderState:
          type: boolean
          default: true
        StartDate:
          type: string
          format: date-time
          description: Date time of the beginning of an operation.
        EndDate:
          type: string
          format: date-time
          description: Date time of the end of an operation.
        ForecastedAmount:
          type: number
          maximum: 99999999.999999
          minimum: 0
        CurrentAmount:
          type: number
          maximum: 99999999.999999
          minimum: 0
          description: Total amount of all completed transactions of a customer order.
        Currency:
          type: string
          pattern: ^[A-Z]{3,3}$
          description: Currency of a monetary amount.
        AccessedBy:
          type: string
          pattern: ^.+$
        AdditionalInformation:
          type: string
          pattern: ^.+$
          description: Unqualified information.
      required:
      - SaleReferenceID
      - StartDate
      - ForecastedAmount
      - CurrentAmount
    TransactionStatusResponse:
      type: object
      description: It conveys Information related to the status of the last or current Payment, Loyalty or Reversal transaction. Content of the TransactionStatus Response message.
      properties:
        Response:
          $ref: '#/components/schemas/Response'
        MessageReference:
          $ref: '#/components/schemas/MessageReference'
        RepeatedMessageResponse:
          $ref: '#/components/schemas/RepeatedMessageResponse'
      required:
      - Response
    OutputText:
      type: object
      description: It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print are parameters valid for the whole Text content. Content of text message to display or print.
      properties:
        Text:
          type: string
        CharacterSet:
          type: integer
        Font:
          type: string
          pattern: ^.+$
        StartRow:
          type: integer
          minimum: 1
          maximum: 500
        StartColumn:
          type: integer
          minimum: 1
          maximum: 500
        Color:
          $ref: '#/components/schemas/Color'
        CharacterWidth:
          $ref: '#/components/schemas/CharacterWidth'
        CharacterHeight:
          $ref: '#/components/schemas/CharacterHeight'
        CharacterStyle:
          $ref: '#/components/schemas/CharacterStyle'
        Alignment:
          $ref: '#/components/schemas/Alignment'
        EndOfLineFlag:
          type: boolean
          default: true
      required:
      - Text
    TrackData:
      type: object
      description: ISO 7813 - ISO 4909.  Generic data structure for a card track, used when the magstripe card reader is located on the Sale Terminal, or for magstripe Card Reader device request. The data structure is also used to store the line at the bottom of a bank check. Magnetic track or magnetic ink characters line.
      properties:
        TrackNumb:
          type: integer
          minimum: 1
          maximum: 3
          default: 2
        TrackFormat:
          $ref: '#/components/schemas/TrackFormat'
        TrackValue:
          type: string
          pattern: ^.{1,104}$
      required:
      - TrackValue
    PaymentInstrumentType:
      type: string
      enum:
      - Card
      - Cash
      - Check
      - Mobile
      - StoredValue
    TokenRequestedType:
      type: string
      enum:
      - Customer
      - Transaction
    InstalmentType:
      type: string
      enum:
      - DeferredInstalments
      - EqualInstalments
      - InequalInstalments
    AuthenticationMethod:
      type: array
      items:
        type: string
        enum:
        - Bypass
        - ManualVerification
        - MerchantAuthentication
        - OfflinePIN
        - OnlinePIN
        - PaperSignature
        - SecureCertificate
        - SecureNoCertificate
        - SecuredChannel
        - SignatureCapture
        - UnknownMethod
    AreaSize:
      type: object
      properties:
        X:
          type: string
        Y:
          type: string
      required:
      - X
      - Y
    RepeatedResponseMessageBody:
      type: object
      properties:
        LoyaltyResponse:
          $ref: '#/components/schemas/LoyaltyResponse'
        PaymentResponse:
          $ref: '#/components/schemas/PaymentResponse'
        ReversalResponse:
          $ref: '#/components/schemas/ReversalResponse'
        StoredValueResponse:
          $ref: '#/components/schemas/StoredValueResponse'
        CardAcquisitionResponse:
          $ref: '#/components/schemas/CardAcquisitionResponse'
        CardReaderAPDUResponse:
          $ref: '#/components/schemas/CardReaderAPDUResponse'
    SaleToIssuerData:
      type: object
      description: The POI System receives this information and sends it to the Acquirer for the Issuer without any change. Sale information intended for the Issuer.
      properties:
        StatementReference:
          type: string
          pattern: ^.+$
          description: Information to print on the bank statement.
    LoyaltyAccount:
      type: object
      description: This data structure conveys the identification of the account and the associated loyalty brand. Data related to a loyalty account processed in the transaction.
      properties:
        LoyaltyAccountID:
          $ref: '#/components/schemas/LoyaltyAccountID'
        LoyaltyBrand:
          type: string
          pattern: ^.+$
          description: If a card is analysed.
      required:
      - LoyaltyAccountID
    PaymentAcquirerData:
      type: object
      description: Data related to the response from the payment Acquirer.
      properties:
        AcquirerID:
          type: integer
          description: If several Acquirers.
        MerchantID:
          type: string
          pattern: ^.+$
          description: Identification of the Merchant for the Acquirer.
        AcquirerPOIID:
          type: string
          pattern: ^.+$
          description: Identification of the POI for the payment Acquirer.
        AcquirerTransactionID:
          $ref: '#/components/schemas/TransactionIDType'
        ApprovalCode:
          type: string
          pattern: ^.+$
          description: If available.
        HostReconciliationID:
          type: string
          pattern: ^.+$
      required:
      - MerchantID
      - AcquirerPOIID
    ErrorCondition:
      type: string
      enum:
      - Aborted
      - Busy
      - Cancel
      - DeviceOut
      - InProgress
      - InsertedCard
      - InvalidCard
      - LoggedOut
      - MessageFormat
      - NotAllowed
      - NotFound
      - PaymentRestriction
      - Refusal
      - UnavailableDevice
      - UnavailableService
      - UnreachableHost
      - WrongPIN
    Point:
      type: object
      properties:
        X:
          type: string
        Y:
          type: string
      required:
      - X
      - Y
    Rebates:
      type: object
      properties:
        TotalRebate:
          type: number
          maximum: 99999999.999999
          minimum: 0
        RebateLabel:
          type: string
          pattern: ^.+$
        SaleItemRebate:
          type: array
          items:
            $ref: '#/components/schemas/SaleItemRebate'
    TransactionIDType:
      type: object
      description: Identification of a transaction for the Sale System or the POI System.
      properties:
        TransactionID:
          type: string
          pattern: ^.+$
        TimeStamp:
          type: string
          format: date-time
      required:
      - TransactionID
      - TimeStamp
    Result:
      type: string
      enum:
      - Failure
      - Partial
      - Success
    CharacterWidth:
      type: string
      enum:
      - DoubleWidth
      - SingleWidth
    CheckData:
      type: object
      description: Allows the check information to be provided by the Sale System before requesting the payment, or stored by the Sale System after processing of the payment. Information related to the paper check used for the transaction.
      properties:
        BankID:
          type: string
          pattern: ^.+$
          description: Mandatory if TrackData absent.
        AccountNumber:
          type: string
          pattern: ^.+$
          description: Mandatory if TrackData absent.
        CheckNumber:
          type: string
          pattern: ^.+$
          description: Mandatory if TrackData absent.
        TrackData:
          $ref: '#/components/schemas/TrackData'
        CheckCardNumber:
          type: string
          pattern: ^.+$
          description: If provided by the customer.
        TypeCode:
          $ref: '#/components/schemas/TypeCode'
        Country:
          type: string
          pattern: ^[A-Z]{3,3}$
          description: Absent if country of the Sale system.
    OutputFormat:
      type: string
      enum:
      - BarCode
      - MessageRef
      - Text
      - XHTML
    SaleItemRebate:
      type: object
      description: To be differentiated from the award which is the amount or quantity earned on the loyalty account. The awarded amount that is attached to an item as a rebate.
      properties:
        ItemID:
          type: integer
          description: Item identification inside a transaction (0 to n).
        ProductCode:
          type: integer
          minimum: 1
          maximum: 20
          description: Product code of item purchased with the transaction.
        EanUpc:
          type: integer
        UnitOfMeasure:
          $ref: '#/components/schemas/UnitOfMeasure'
        Quantity:
          type: string
          description: if rebate is additional units.
        ItemAmount:
          type: number
          maximum: 99999999.999999
          minimum: 0
          description: if rebate on the line item amount.
        RebateLabel:
          type: string
          pattern: ^.+$
          description: If provided by the Acquirer.
      required:
      - ItemID
      - ProductCode
    PaymentType:
      type: string
      enum:
      - CashAdvance
      - CashDeposit
      - Completion
      - FirstReservation
      - Instalment
      - IssuerInstalment
      - Normal
      - OneTimeReservation
      - PaidOut
      - Recurring
      - Refund
      - UpdateReservation
    MessageClass:
      type: string
      enum:
      - Device
      - Event
      - Service
    RepeatedMessageResponse:
      type: object
      properties:
        MessageHeader:
          $ref: '#/components/schemas/MessageHeader'
        RepeatedResponseMessageBody:
          $ref: '#/components/schemas/RepeatedResponseMessageBody'
      required:
      - MessageHeader
      - RepeatedResponseMessageBody
    TypeCode:
      type: string
      enum:
      - Company
      - Personal
    DocumentQualifier:
      type: string
      enum:
      - CashierReceipt
      - CustomerReceipt
      - Document
      - Journal
      - SaleReceipt
      - Voucher
    PaymentToken:
      type: object
      description: Surrogate of the PAN (Primary Account Number) of the payment card to  identify the payment mean of the customer. It allows, for a merchant, to identify   the customer.
      properties:
        TokenRequestedType:
          $ref: '#/components/schemas/TokenRequestedType'
        TokenValue:
          type: string
          pattern: ^.+$
        ExpiryDateTime:
          type: string
          format: date-time
          description: Expiry date and time. Limits the validity of a payment token.
      required:
      - TokenRequestedType
      - TokenValue
    StoredValueResponse:
      type: object
      description: It conveys Information related to the Stored Value transaction processed by the POI System. Content of the Stored Value Response message.
      properties:
        Response:
          $ref: '#/components/schemas/Response'
        SaleData:
          $ref: '#/components/schemas/SaleData'
        POIData:
          $ref: '#/components/schemas/POIData'
        StoredValueResult:
          type: array
          items:
            $ref: '#/components/schemas/StoredValueResult'
        PaymentReceipt:
          type: array
          items:
            $ref: '#/components/schemas/PaymentReceipt'
      required:
      - Response
      - SaleData
      - POIData
    SensitiveMobileData:
      type: object
      properties:
        MSISDN:
          type: integer
        ISMI:
          type: integer
        IMEI:
          type: integer
      required:
      - MSISDN
    SaleTerminalData:
      type: object
      description: In the Login Request, if a Sale Terminal is involved in the login. In other messages, when a logical device is out of order (SaleCapabilites), or when the other data have changed since or were not in the Login. Information related to the software and hardware feature of the Sale Terminal.
      properties:
        TotalsGroupID:
          type: string
          pattern: ^.{1,16}$
          description: If present, default value for all transaction.
    CustomerOrderReq:
      type: array
      items:
        type: string
        enum:
        - Both
        - Closed
        - Open
    CardReaderAPDUResponse:
      type: object
      description: It contains the result of the requested service, APDU response sent by the chip of the card in response to the APDU request. Content of the Card Reader APDU Response message.
      properties:
        Response:
          $ref: '#/components/schemas/Response'
        APDUData:
          type: string
          format: byte
          pattern: ^.+$
          description: Data field of the APDU command (Lc + Data).
        CardStatusWords:
          type: string
          format: byte
          pattern: ^.{2,2}$
          description: Status of a smartcard response to a command (SW1-SW2).
      required:
      - Response
      - CardStatusWords
    MessageReference:
      type: object
      description: To abort a transaction in progress or to request the status of a transaction from which no response has been received.  It identifies the message header of the message request to abort or request the status. Identification of a previous POI transaction.
      properties:
        MessageCategory:
          $ref: '#/components/schemas/MessageCategory'
        ServiceID:
          type: string
          pattern: ^.{1,10}$
          description: Identification of a message pair, which processes a transaction.
        DeviceID:
          type: string
          pattern: ^.{1,10}$
          description: Identification of a device message pair.
        SaleID:
          type: string
          pattern: ^.+$
          description: default MessageHeader.SaleID.
        POIID:
          type: string
          pattern: ^.+$
          description: default MessageHeader.POIID.
    LoyaltyAmount:
      type: object
      description: An awarded amount or an amount to redeem to the loyalty account might be sent in the Payment request message. Amount of a loyalty account.
      properties:
        LoyaltyUnit:
          $ref: '#/components/schemas/LoyaltyUnit'
        Currency:
          type: string
          pattern: ^[A-Z]{3,3}$
        AmountValue:
          type: number
          maximum: 99999999.999999
          minimum: 0
      required:
      - AmountValue
    Instalment:
      type: object
      properties:
        InstalmentType:
          $ref: '#/components/schemas/InstalmentType'
        SequenceNumber:
          type: integer
        PlanID:
          type: string
          pattern: ^.+$
        Period:
          type: integer
        PeriodUnit:
          $ref: '#/components/schemas/PeriodUnit'
        FirstPaymentDate:
          type: string
          format: date
        TotalNbOfPayments:
          type: integer
        CumulativeAmount:
          type: number
          maximum: 99999999.999999
          minimum: 0
        FirstAmount:
          type: number
          maximum: 99999999.999999
          minimum: 0
        Charges:
          type: number
          maximum: 99999999.999999
          minimum: 0
    EntryMode:
      type: array
      items:
        type: string
        enum:
        - Contactless
        - File
        - ICC
        - Keyed
        - MagStripe
        - Manual
        - Mobile
        - RFID
        - Scanned
        - SynchronousICC
        - Tapped
    StoredValueTransactionType:
      type: string
      enum:
      - Activate
      - Duplicate
      - Load
      - Reserve
      - Reverse
      - Unload
    OutputContent:
      type: object
      description: This is a sequence of elements if they have different formats. Content to display or print.
      properties:
        OutputFormat:
          $ref: '#/components/schemas/OutputFormat'
        PredefinedContent:
          $ref: '#/components/schemas/PredefinedContent'
        OutputText:
          type: array
          items:
            $ref: '#/components/schemas/OutputText'
        OutputXHTML:
          type: string
          format: byte
          pattern: ^.{0,262144}$
          description: Mandatory, if OutputFormat is XHTML, not allowed otherwise.
        OutputBarcode:
          $ref: '#/components/schemas/OutputBarcode'
      required:
      - OutputFormat
    IdentificationType:
      type: string
      enum:
      - AccountNumber
      - BarCode
      - ISOTrack2
      - PAN
      - PhoneNumber
    BarcodeType:
      type: string
      enum:
      - Code128
      - Code25
      - EAN13
      - EAN8
      - PDF417
      - QRCode
      - UPCA
    UnitOfMeasure:
      type: string
      enum:
      - Case
      - Centilitre
      - Centimetre
      - Foot
      - Gram
      - Inch
      - Kilogram
      - Kilometre
      - Litre
      - Meter
      - Mile
      - Other
      - Ounce
      - Pint
      - Pound
      - Quart
      - UKGallon
      - USGallon
      - Yard
    Geolocation:
      type: object
      properties:
        GeographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinates'
        UTMCoordinates:
          $ref: '#/components/schemas/UTMCoordinates'
    TrackFormat:
      type: string
      enum:
      - AAMVA
      - ISO
    PaymentReceipt:
      type: object
      description: If the payment receipts are printed by the Sale system and the POI or the Sale does not implement the Print exchange (Basic profile). Customer or Merchant payment receipt.
      properties:
        DocumentQualifier:
          $ref: '#/components/schemas/DocumentQualifier'
        IntegratedPrintFlag:
          type: boolean
          description: Type of the print integrated to other prints.
        RequiredSignatureFlag:
          type: boolean
          default: false
          description: Indicate that the cardholder payment receipt requires a physical signature by the Customer.
        OutputContent:
          $ref: '#/components/schemas/OutputContent'
      required:
      - DocumentQualifier
      - OutputContent
    TransactionStatusRequest:
      type: object
      description: It conveys Information requested for status of the last or current Payment, Loyalty or Reversal transaction. Content of the TransactionStatus Request message.
      properties:
        MessageReference:
          $ref: '#/components/schemas/MessageReference'
        ReceiptReprintFlag:
          type: boolean
          default: false
          description: Request to reprint the POI receipt(s).
        DocumentQualifier:
          type: array
          items:
            $ref: '#/components/schemas/DocumentQualifier'
    PaymentResult:
      type: object
      properties:
        PaymentType:
          $ref: '#/components/schemas/PaymentType'
        PaymentInstrumentData:
          $ref: '#/components/schemas/PaymentInstrumentData'
        AmountsResp:
          $ref: '#/components/schemas/AmountsResp'
        Instalment:
          $ref: '#/components/schemas/Instalment'
        CurrencyConversion:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyConversion'
        MerchantOverrideFlag:
          type: boolean
          default: false
        CapturedSignature:
          $ref: '#/components/schemas/CapturedSignature'
        ProtectedSignature:
          type: string
        CustomerLanguage:
          type: string
          pattern: ^[a-z]{2,2}$
        OnlineFlag:
          type: boolean
          default: true
        AuthenticationMethod:
          $ref: '#/components/schemas/AuthenticationMethod'
        ValidityDate:
          type: string
          format: date
        PaymentAcquirerData:
          $ref: '#/components/schemas/PaymentAcquirerData'
    PredefinedContent:
      type: object
      description: It conveys Information related to the predefined message. Reference of a predefined message to display or print.
      properties:
        ReferenceID:
          type: string
          pattern: ^.+$
          description: Identification of a predefined message to display or print.
        Language:
          type: string
          pattern: ^[a-z]{2,2}$
          description: Identification of a language.
      required:
      - ReferenceID
    LoyaltyResponse:
      type: object
      description: It conveys Information related to the Loyalty transaction processed by the POI System. Content of the Loyalty Response message.
      properties:
        Response:
          $ref: '#/components/schemas/Response'
        SaleData:
          $ref: '#/components/schemas/SaleData'
        POIData:
          $ref: '#/components/schemas/POIData'
        LoyaltyResult:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyResult'
        PaymentReceipt:
          type: array
          items:
            $ref: '#/components/schemas/PaymentReceipt'
      required:
      - Response
      - SaleData
      - POIData
    MessageHeader:
      type: object
      description: It conveys Information related to the Sale to POI protocol management. Message header of the Sale to POI protocol message.
      properties:
        ProtocolVersion:
          type: string
          pattern: ^.+$
          description: If MessageCategory is Login or Diagnosis.
        MessageClass:
          $ref: '#/components/schemas/MessageClass'
        MessageCategory:
          $ref: '#/components/schemas/MessageCategory'
        MessageType:
          $ref: '#/components/schemas/MessageType'
        ServiceID:
          type: string
          pattern: ^.{1,10}$
          description: Required if Service or Event MessageClass message or if Device MessageClass and request from POI or response from Sale.
        DeviceID:
          type: string
          pattern: ^.{1,10}$
          description: If Device MessageClass.
        SaleID:
          type: string
          pattern: ^.+$
          description: Identification of a Sale System or a Sale Terminal for the Sale to POI protocol.
        POIID:
          type: string
          pattern: ^.+$
          description: Identification of a POI System or a POI Terminal for the Sale to POI protocol.
      required:
      - MessageClass
      - MessageCategory
      - MessageType
      - SaleID
      - POIID
    POIData:
      type: object
      description: In the Message Response, identification of the POI transaction. Data related to the POI System.
      properties:
        POITransactionID:
          $ref: '#/components/schemas/TransactionIDType'
        POIReconciliationID:
          type: integer
          description: If Result is Success.
      required:
      - POITransactionID
    CurrencyConversion:
      type: object
      description: A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt). Information related to a currency conversion.
      properties:
        CustomerApprovedFlag:
          type: boolean
          default: true
          description: Notify if the customer has approved something. Indicates if the customer has accepted a currency conversion.
        ConvertedAmount:
          $ref: '#/components/schemas/ConvertedAmount'
        Rate:
          type: string
          description: Rate of currency conversion.
        Markup:
          type: string
          description: Markup of a currency conversion amount as a percentage.
        Commission:
          type: number
          maximum: 99999999.999999
          minimum: 0
          description: Commission for a currency conversion.
        Declaration:
          type: string
          pattern: ^.+$
          description: If a decl

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-transactionstatus-api-openapi.yml