Card Payment
Call method SaleTransaction() with parameters SaleParameters. This call returns the SaleResponse object. The following tables describe the object and its parameters.
SaleTransaction Request Elements – SaleParameters
Element | Required | Type | Constraint | Comments |
TransAmount | Yes | String | Numeric, max 12 digits | Requested amount including any Tip entered at Kiosk |
Tip Amount | No | String | Numeric, max 12 digits | Tip amount (in minor denominations). Present if applicable. |
Operator | Yes | String | String – max 26 bytes | Cashier Id (To be determined) |
CheckNo | Yes | String | String – max 20 bytes | Simphony Check Number |
SaleTransaction Response Elements – SaleResponse
Element | Required | Type | Constraint | Comments |
SequenceNo | Yes | String | Numeric, max 12 digits | Unique Transaction Identifier |
TransAmount | Yes | String | Numeric, max 12 digits | Approved Amount including any Tip |
Tip Amount | No | String | Numeric, max 12 digits | Tip amount (in minor denominations). Present if applicable. |
RespCode | Yes | String | String, 2 bytes |
00: Approved 10: Partial Amount Approved Else: Denied |
RespText | Yes | String | String, max 32 bytes | Response Text (if not approved) |
RRN | Yes | String | String, 12 bytes | Retrieval reference number |
AlternateTransRef | If Approved | String | String, max 64 bytes | Alternative Transaction Reference |
OfflineFlag | No | String | 1 byte | Offline flag (values: Y/N) |
TransToken | If Approved | String | String, max 30 bytes |
Required for approval Not required for denied |
IssuerId | If Approved | String | String, 2 bytes | Card Type Id |
PAN | If Approved | String | String, max 19 bytes | Masked PAN, include last 4 digits. |
ExpiryDate | If Approved | String | Numeric, 4 digits | Expiry date, format is YYMM |
EntryMode | If Approved | String | String, 2 bytes | Entry Mode |
BinRange | If Approved | String | String, max 8 bytes | Payment cards BIN (Bank Identification Number, also known as IIN). BIN is usually 6 digits but can also be 7 or 8 digits. |
AuthCode | If Approved | String | String, 2-6 bytes | Approval Code |
MerchantId | No | String | String, max 15 bytes | Merchant Id |
TerminalId | No | String | String, max 8 bytes | Payment Terminal Id |
ExtTerminalId | No | String | String, max 32 bytes | Payment Terminal Id – Long Format |
MinimumVoucherData | No | String | String, Max 8192 bytes | Formatted, minimum voucher data, designed to be embedded in Guest Check/Receipt |
PrintData | If Approved | String | String, max 8192 | Formatted voucher data for separate voucher document |
ModificationReference | No | String | String, max 64 bytes | Transaction Reference |
Parent topic: Transactions