Sample Responses

Field

Type

Description

Sample

RefId *

string

Unique reference ID assigned to the transaction.

688041066395

AuthCode *

string

Unique transaction hash key.

83398129492534106720240723110923

PNRef *

string

RRN number used to track transaction details.

400907500270

TransNum *

string

Invoice number

4

ResultCode *

string

For a successful transaction, the code is 0 or 00. If the code is anything else (!= 0), the transaction is considered a failure.

00

Message *

string

General message from the payment processor after completing the transaction.

APPROVED

RespMsg *

string

Additional processor message, sometimes with more detail.

APPROVAL DSC380

PaymentType *

string

Indicates whether the transaction was made via credit or debit.

credit

CardType *

string

The type of card used in the transaction.

VISA, MASTERCARD

Amount *

string

Base transaction amount before taxes, tips, or fees.

10.00

Tip

string

Tip amount, if tip was enabled for the TPN and applied.

$1.00

TaxCity

string

Local tax amount, if local tax is enabled. Local fee may also apply if configured.

2.00

Tax1Label

string

Label for the local tax (Tax 1), set in edit parameters on the portal.

Local Tax

TaxState

string

State tax amount, if state tax is enabled. A state-level fee may also apply if configured.

1.00

Tax2Label

string

Label for the state tax (Tax 2), set in edit parameters on the portal.

State Tax

Fee

string

Fee amount applied to the transaction, as configured in the portal under Edit Parameters.

0.40

FeeLabel

string

Label assigned to the custom fee in the portal (e.g., “Custom Fee”).

Custom Fee

BaseAmount *

string

The original transaction amount before taxes, tips, and fees.

10.00

BatchNum *

string

The batch number the transaction belongs to. Batches are used for settlement.

121

AcntLast4 *

string

Last four digits of the customer’s card number used in the transaction.

5859

AcntFirst4

string

First four digits of the card number used in the transaction.

3530

TotalAmt *

string

Total amount charged for the transaction, including taxes, tip, and fee.

13.40

TaxAmount

string

Combined total of applicable taxes (e.g., city, state).

2.00

RespCode *

string

For a successful transaction, the code is 0 or 00. If the code is anything else (!= 0), the transaction is considered a failure.

00

RRN *

string

Retrieval Reference Number (RRN) for the transaction, used for tracking and reconciliation.

400907500270

TraceNum *

string

The invoice or trace number for the transaction. Typically used for internal tracking.

4

HostTxnId *

string

Transaction ID assigned by the acquiring host system.

123456789012345

txnId *

string

Unique transaction ID used for tracking.

00000433772392582420240109012159

TxnType *

string

Indicates the type of transaction (e.g., 1 = Sale, 2 = Refund, etc.).

1

EntryType *

string

How the card data was entered (e.g., tap-on-phone, chip, manual entry).

tap-on-phone

txnLabel *

string

A short text label indicating the transaction type (e.g., sale, refund).

sale

networkMode

string

Type of network used by the device at the time of transaction (e.g., WIFI, LTE, Ethernet).

WIFI

DateTime *

string

Timestamp of the transaction in YYYYMMDDhhmmss format.

20240222173537

iPOSToken *

string

A unique token generated by the iPOS system that can be used to reference the transaction securely.

CE268D77935FDBF3F9C72E7

HostResponseCode *

string

The host system’s response code. For a successful transaction, the code is 0 or 00. If the code is anything else (!= 0), the transaction is considered a failure.

00

HostResponseMessage *

string

Text response from the host system indicating transaction status.

APPROVAL DSC380