Fields

msgType

Enum

Specifies the type of transaction being initiated.

Must be a valid MsgType enum value.

MsgType.SALE

invoiceNbr

String

Unique identifier for the transaction invoice.

Alphanumeric, typically 8–12 characters.

10120304

amount

Integer

Transaction amount in minor currency units (e.g., cents).

Must be a positive integer.

1500

currency

String

ISO 4217 currency code for the transaction.

Must be a valid 3-letter currency code.

USD

readerType

Enum

Specifies the card reader method used for the transaction.

Optional; must be a valid ReaderType enum value.

ReaderType.INSERT_CLESS_SWIPE

stan

Integer

System Trace Audit Number used to reference a previous transaction.

Required for completion and void transactions.

2

tokenReq

Boolean

Indicates whether a token is requested for the transaction.

true or false

true

agreementID

String

Identifier for the merchant agreement related to the transaction.

Alphanumeric, format may include date and sequence.

MERCH123_20250804_001

agreementType

String

Type of merchant agreement.

Typically a single character code.

I

msgType

String

Type of transaction response

Must be one of SALE, PREAUTH, SALECOMP, VOID, REFUND

SALE

responseCodes

String

Response code from the transaction

Typically '00' for success

00

responseText

String

Textual description of the response

Should match responseCodes meaning

Success

dateTime

Datetime

Timestamp of the transaction

ISO 8601 format

2025-10-27T02:21:14Z

cardEntryMode

String

Mode of card entry

Single character code (e.g., C for contactless)

C

cardExpiryDate

String

Card expiration date

Nullable; format MMYY

null

cardBin

String

Bank Identification Number of the card, first 6 digits of the PAN

6-digit numeric

541333

cardLast4

String

Last 4 digits of the card number

4-digit numeric

0010

cardSchemeName

String

Card brand name

Nullable

MasterCard

cardSchemeAppName

String

Application name on the card

Nullable

PPC MCD 01 v2 2

cardholderName

String

Name of the cardholder

Nullable

null

sessionGUID

String

Session identifier for the transaction

UUID format; Nullable

040fd541-faf8-445d-a8e6-2b4ccd641cbf

stan

String

System Trace Audit Number

6-digit numeric

000001

token

String

Tokenized card reference

Nullable

248757

rrn

String

Retrieval Reference Number

Nullable; numeric

100001652541

totalAmount

Float

Total transaction amount

Must be positive

15.0

onlineIndicator

String

Indicates if transaction was online

Y or N

Y

receipt

String

Formatted receipt text

Multiline string

MID M11000000000098 ...

emvPix

String

EMV PIX value

4-digit hexadecimal

1010

emvRid

String

EMV RID value

Hexadecimal string

A000000004

emvTsi

String

EMV TSI value

4-digit hexadecimal

0000

emvTvr

String

EMV TVR value

8-digit hexadecimal

0000008001

emvArqc

String

EMV ARQC value

Hexadecimal string; Nullable

BAA0082B5C384C2A

Receipt Fields:

MID

String

Merchant Identifier

Alphanumeric, fixed length

M11000000000098

TERM

String

Terminal Identifier

Alphanumeric, fixed length

T1100039

DATE

String

Transaction Date and Time

Format: YYYYMMDDHHMMSS

20251027132044

TRAN

Integer

Transaction Sequence Number

Positive integer

8

CARD

String

Masked Card Number

Last 4 digits visible

************0010

Card Scheme

String

Card Brand Name

Standard card brand

MasterCard

Card Scheme App Name

String

Card Application Name

Descriptive name

PPC MCD 01 v2 2

Entry Mode

String

Card Entry Method

Descriptive label

CONTACTLESS

Transaction Type

String

Type of Transaction

Standard transaction type

REFUND

AID

String

Application Identifier

Hexadecimal format

A0000000041010

AMOUNT

Float

Transaction Amount

Currency format

$15.00

TOTAL

Float

Total Amount

Currency format

$15.00

CURRENCY

String

Transaction Currency

ISO 4217 format

USD

Verification Status

String

Cardholder Verification Result

Descriptive label

No Cardholder Verification