ColossusColossus
API Reference

Schemas

Data models and type definitions.


ARQC

ISO 8583 Authorization Request Cryptogram message. Wire format is binary.

PropertyTypeRequiredDescription
mtistring✓Message Type Indicator (0100 = Authorization Request)
fieldsobject✓
fields.2stringDE2: Primary Account Number (PAN)
fields.3stringDE3: Processing Code
fields.4stringDE4: Amount, Transaction
fields.11stringDE11: Systems Trace Audit Number
fields.12stringDE12: Date and Time, Local Transaction
fields.13stringDE13: Date, Local Transaction
fields.14stringDE14: Date, Expiration
fields.18stringDE18: Merchant Type
fields.22stringDE22: Point of Service Entry Mode
fields.23stringDE23: Card Sequence Number
fields.25stringDE25: Point of Service Condition Code
fields.35stringDE35: Track 2 Data
fields.37stringDE37: Retrieval Reference Number
fields.41stringDE41: Card Acceptor Terminal Identification
fields.42stringDE42: Card Acceptor Identification Code
fields.43stringDE43: Card Acceptor Name/Location
fields.49stringDE49: Currency Code, Transaction
fields.55stringDE55: ICC System Related Data (EMV Data - TLV encoded)
fields.62string✓DE62: Custom Data (RSA public key: modulus + exponent, and RSA signature)

ARPC

ISO 8583 Authorization Response Cryptogram message. Wire format is binary.

PropertyTypeRequiredDescription
mtistring✓Message Type Indicator (0110 = Authorization Response)
fieldsobject✓
fields.2stringDE2: Primary Account Number (PAN)
fields.3stringDE3: Processing Code
fields.4stringDE4: Transaction Amount
fields.11stringDE11: Systems Trace Audit Number (STAN)
fields.12stringDE12: Local Transaction Time (HHMMSS)
fields.13stringDE13: Local Transaction Date (MMDD)
fields.37stringDE37: Retrieval Reference Number (RRN)
fields.38stringDE38: Authorization ID Response
fields.39string✓DE39: Response Code (00=Approved, 05=Declined)
fields.41stringDE41: Card Acceptor Terminal ID
fields.42stringDE42: Card Acceptor ID (Merchant ID)
fields.55stringDE55: ICC/EMV Data (contains ARPC cryptogram)
fields.62stringDE62: Transaction Result (JSON)

RSASignature

RSA public key (modulus + exponent) and signature from DE62 for EMV validation.

PropertyTypeRequiredDescription
modulusstring✓RSA Modulus (Tag DF01, 256 bytes hex for RSA-2048)
exponentstring✓RSA Exponent (Tag DF02, typically 010001)
signaturestring✓RSA Signature (Tag DF03, 256 bytes hex)

EMVData

EMV/ICC data extracted from DE55 TLV-encoded field.

PropertyTypeRequiredDescription
amountstring✓Tag 9F02: Authorized Amount (12 digits)
currencystring✓Tag 5F2A: Transaction Currency Code
terminalCountrystring✓Tag 9F1A: Terminal Country Code
terminalVerificationResultsstring✓Tag 95: Terminal Verification Results (5 bytes hex)
transactionDatestring✓Tag 9A: Transaction Date (YYMMDD)
transactionTypestring✓Tag 9C: Transaction Type
unpredictableNumberstring✓Tag 9F37: Unpredictable Number (4 bytes hex)
applicationInterchangeProfilestring✓Tag 82: Application Interchange Profile (2 bytes hex)
applicationTransactionCounterstring✓Tag 9F36: Application Transaction Counter (2 bytes hex)
cryptogramstring✓Tag 9F26: Application Cryptogram (ARQC)
cryptogramInformationDatastring✓Tag 9F27: Cryptogram Information Data
issuerApplicationDatastringTag 9F10: Issuer Application Data
terminalCapabilitiesstringTag 9F33: Terminal Capabilities (3 bytes hex)
cvmResultsstringTag 9F34: CVM Results (3 bytes hex)

ServiceInfo

PropertyTypeRequiredDescription
servicestring✓
versionstring✓
endpointsobject✓
endpoints.healthstring✓
endpoints.arqcstring✓
endpoints.metricsstring✓
endpoints.docsstring✓

ContractAddresses

PropertyTypeRequiredDescription
emvValidatorstring✓
emvSettlementstring✓

DatabaseHealth

PropertyTypeRequiredDescription
healthyboolean✓

HealthCheck

PropertyTypeRequiredDescription
statusstring✓Overall service health status
servicestring✓
timestampstring✓
sponsorstring✓
contractsContractAddresses✓
databaseDatabaseHealth✓

Contracts

PropertyTypeRequiredDescription
emvValidatorstring✓
emvSettlementstring✓

DatabaseStatus

PropertyTypeRequiredDescription
healthyboolean✓

Error

PropertyTypeRequiredDescription
errorstring✓
messagestring

HealthResponse

PropertyTypeRequiredDescription
statusstring✓Overall service health status
servicestring✓
timestampstring✓
sponsorstring✓
contractsContractAddresses✓
databaseDatabaseHealth✓

On this page