Skip to content

[Documentation] Complete Cloud device API migration guide (enum values, renames, SaleToAcquirerData) #1999

Description

@gcatanese

Context

The Migrating from Terminal (Cloud) API to Cloud device API guide documents the differences between the nexo (Terminal (Cloud) API) and tapi (Cloud device API) models.

While cross-checking the equivalent Node.js migration guide against the shared OpenAPI (tapi) diff, several spec-driven changes that are present in the Java com.adyen.model.tapi package turned out to be missing from the guide. These were verified directly against the generated Java tapi sources.

Proposed Change

Add the following to doc/MigratingToCloudDeviceApi.md:

  1. A new "Enum value differences" section. Enum values (not just names) changed, so code using old values will not compile:

    • CharacterStyle: Underlined -> UNDERLINE
    • MessageCategory: removed Batch, CardReaderAPDU, CardReaderInit, CardReaderPowerOff, PIN, Sound, Transmit; added NONE
    • EventToNotify: removed NetworkConnected/NetworkDisconnected; added USE_ANOTHER_CARD_FOR_PREAUTH
    • TrackFormat: removed JisI/JisIi
  2. A "Property renames" table:

    • ICCResetData: AtrValue -> ATRValue
    • SoundContent: Value -> Text
    • TrackData: Value -> TrackValue
    • StoredValueAccountID: Value -> StoredValueID
  3. Expand the "Model classes" rename table (currently only lists TransactionIdentification -> TransactionIDType) with the other renamed classes present in tapi:

    • CheckTypeCodeType -> TypeCode
    • SignaturePoint -> Point
    • CardholderPIN -> CardHolderPIN
    • StoredValueAccountId -> StoredValueAccountID
    • LoyaltyAccountId -> LoyaltyAccountID
    • InstalmentType -> Instalment (e.g. PaymentResult.getInstalment() now returns Instalment)
  4. Document the SaleToAcquirerData field type change: in tapi, SaleData.saleToAcquirerData is now a String (it was a SaleToAcquirerData object in nexo). Integrations that built applicationInfo/merchantApplication via that object must update their code.

Benefit

  • Prevents migration surprises: the enum value changes and SaleToAcquirerData type change cause compile errors or behavior changes that the guide currently does not warn about.
  • Completes the model/property rename reference so developers can map their existing code accurately.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIndicates the PR updates documentation and doesn't involve code.do not stale

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions