Developer Docs

Developer Docs

  • Overview
  • SDK
  • SoftPOS API
  • APOLLO API
  • Release Note
  • Languages iconEnglish
    • 繁體中文

›SoftPOS API

SoftPOS API

  • API preview
  • Transaction request
  • Enquiry Request
  • Data models

Data models

Credential (reference only)

data class Credential(
    val name: String? = null,
    val env: String? = null,
    val shop: String? = null,
    val apiKey: String? = null,
    val apiToken: String? = null,
)

TransactionRequest

data class TransactionRequest(
    val requestAmount: BigDecimal? = null,
    val tranType: TranType? = null,
    val preferredInstrument: PreferredInstrument? = null,
    /**
     * The unique ID from the POS
     */
    val messageId: String,
    /**
     * Conditional required for void, auth complete
     */
    val tranId: String? = null,
    /**
     * Optional field for merchant remarks
     */
    val description: String? = null
) : Serializable

EnquiryRequest

data class EnquiryRequest(
    /**
     * The unique ID from the POS
     */
    val messageId: String
) : Serializable

PreferredInstrument

enum class PreferredInstrument {
    CASH,
    CARD,
    QR
}

TranType

enum class TranType {
    SALE,
    VOID,
    REFUND,
    AUTH,
    AUTH_COMPLETE,
}

Last updated on 8/20/2021 by Jeff Kwok
← Enquiry Request
  • Credential (reference only)
  • TransactionRequest
  • EnquiryRequest
  • PreferredInstrument
  • TranType
Developer Docs
About
APOLLO ecosystemProducts and servicesHardware spec
Development
Development with APOLLOSDK overviewAPI overview
Support
Spectra TechnologiesContact us
Copyright © 2022 Spectra Technologies.
Site by Docusaurus