Virtual Terminal API Sample Responses

Provides example success and error responses to help understand the virtual terminal API response structure and handling.

Sale API

Process a card sale transaction.

---

Response — 200 OK (Approved)

JSON

{
  "error_no": "S00",
  "success_url": true,
  "error_code": "00",
  "amount": "10.12",
  "tax": "0",
  "customfee": "0.2",
  "msg": "APPROVED",
  "desc": "APPROVAL TAS827",
  "additional_info": null,
  "clerk_id": null,
  "clerk_name": null,
  "clerk_label": null,
  "additionalKeyOne": null,
  "additionalKeyTwo": null,
  "additionalValueOne": null,
  "additionalValueTwo": null,
  "approval_code": "TAS827",
  "rrn": "611809502890",
  "txnid": "10333392",
  "created_date": "28/04/2026",
  "created_time": "05:56:08",
  "tran_no": 1,
  "stan": 712091,
  "batch_no": 211,
  "is_partial_approve": 0,
  "partial_amount": "000000001012",
  "pan": "XXXX1111",
  "card_type": null,
  "phone_number": null,
  "email_id": null,
  "zip": null,
  "card_holder_name": null,
  "expiry_date": "12/36",
  "address": null,
  "epi": "2319916062",
  "channel": "VT",
  "orderdescription": null,
  "invoicenumber": null,
  "token": "64E357AB********F2C5F6D4",
  "card_brand": "Visa",
  "netamt": 10.31
}

Response fields

Field	Type	Description
error_no	string	S00 indicates a successful transaction
success_url	boolean	true when the transaction is approved
error_code	string	Gateway error code. 00 = no error
amount	string	Charged amount in decimal format
tax	string	Tax amount applied
customfee	string	Custom fee applied to the transaction
msg	string	Result (e.g. APPROVED)
desc	string	Detailed description including the approval code
additional_info	string | null	Reserved for additional metadata
clerk_id	string | null	Clerk identifier, if provided
clerk_name	string | null	Clerk name, if provided
clerk_label	string | null	Clerk label, if provided
additionalKeyOne	string | null	Custom key field 1
additionalKeyTwo	string | null	Custom key field 2
additionalValueOne	string | null	Custom value field 1
additionalValueTwo	string | null	Custom value field 2
approval_code	string	Issuer-returned authorization code
rrn	string	Retrieval reference number for reconciliation
txnid	string	Unique transaction identifier
created_date	string	Transaction date in DD/MM/YYYY format
created_time	string	Transaction time in HH:MM:SS format
tran_no	integer	Sequential transaction number within the batch
stan	integer	System trace audit number
batch_no	integer	Settlement batch identifier
is_partial_approve	integer	1 if partially approved; 0 for full approval
partial_amount	string	Approved amount in zero-padded 12-digit format
pan	string	Masked card number — last 4 digits shown (e.g. XXXX1111)
card_type	string | null	Card type, if returned by the issuer
phone_number	string | null	Cardholder phone number, if provided
email_id	string | null	Cardholder email address, if provided
zip	string | null	Billing ZIP code, if provided
card_holder_name	string | null	Name on card, if provided
expiry_date	string	Card expiry in MM/YY format
address	string | null	Billing address, if provided
epi	string	Merchant terminal / EPI identifier
channel	string	Transaction channel (e.g. VT, ECOMM)
orderdescription	string | null	Item or order description, if provided
invoicenumber	string | null	Merchant-supplied invoice reference, if provided
token	string	Partially masked card token for future use
card_brand	string	Card network (e.g. Visa, Mastercard)
netamt	number	Net amount charged including fees

---

Response — 400 (Processing Error)

JSON

{
  "error_no": "E26",
  "mesg": "PROCESSING ERROR",
  "msg": "PROCESSING ERROR",
  "desc": "AUTHENTICATION FAILED"
}

Response fields

Field	Type	Description
error_no	string	E26 indicates an authentication failure
mesg	string	Error message
msg	string	Error message
desc	string	Detailed description of the error cause

---

Response — 400 (Declined)

JSON

{
  "error_no": "E98",
  "error_code": "96",
  "success_url": false,
  "txnid": "10333383",
  "batch_no": 0,
  "switch_error_code": "V0417",
  "mesg": "Merchant Not Active",
  "desc": "Error code :96",
  "msg": "Merchant Not Active",
  "isFlexSendOrNot": "V0417"
}

Response fields

Field	Type	Description
error_no	string	E98 indicates a declined transaction
error_code	string	Decline code (e.g. 96 = merchant not active)
success_url	boolean	Always false for declined transactions
txnid	string	Transaction identifier (assigned even on decline)
batch_no	integer	Settlement batch identifier. Returns 0 when the merchant is inactive
switch_error_code	string	Switch-level error code returned by the network
mesg	string	Error message
msg	string	Error message
desc	string	Detailed error description
isFlexSendOrNot	string	Flex routing indicator; mirrors switch_error_code

---

Error code reference

error_no	Meaning	Typical cause
S00	Approved	Transaction successful
E26	Processing error	Authentication credentials are invalid
E98	Declined	Merchant account is not active

---

Capture API

Capture a previously authorized (pre-auth) transaction and move it to the open batch for settlement.

---

Response — 200 OK (Approved)

JSON

{
  "error_no": "S00",
  "success_url": true,
  "error_code": "00",
  "amount": "0.67",
  "tax": "0",
  "customfee": "14",
  "msg": "APPROVED",
  "desc": "APPROVAL TAS846",
  "additional_info": null,
  "clerk_id": null,
  "clerk_name": null,
  "clerk_label": null,
  "additionalKeyOne": null,
  "additionalKeyTwo": null,
  "additionalValueOne": null,
  "additionalValueTwo": null,
  "approval_code": "TAS846",
  "rrn": "611809502918",
  "txnid": "10333404",
  "created_date": "28/04/2026",
  "created_time": "05:59:06",
  "tran_no": 3,
  "stan": 712108,
  "batch_no": 211,
  "is_partial_approve": 0,
  "partial_amount": "000000000067",
  "pan": "XXXX",
  "card_type": null,
  "phone_number": null,
  "email_id": null,
  "zip": null,
  "card_holder_name": null,
  "expiry_date": "/",
  "address": null,
  "epi": "2319916062",
  "channel": "VT",
  "orderdescription": null,
  "invoicenumber": null,
  "token": null,
  "card_brand": null,
  "netamt": 0.81
}

Response fields

Field	Type	Description
error_no	string	S00 indicates a successful capture
success_url	boolean	true when the capture is approved
error_code	string	Gateway error code. 00 = no error
amount	string	Captured amount in decimal format
tax	string	Tax amount
customfee	string	Custom fee applied
msg	string	Result (e.g. APPROVED)
desc	string	Detailed description including the approval code
approval_code	string	Issuer-returned authorization code
rrn	string	Retrieval reference number
txnid	string	Unique transaction identifier for the capture
created_date	string	Capture date in DD/MM/YYYY format
created_time	string	Capture time in HH:MM:SS format
tran_no	integer	Sequential transaction number within the batch
stan	integer	System trace audit number
batch_no	integer	Settlement batch identifier
is_partial_approve	integer	1 if partially approved; 0 for full capture
partial_amount	string	Captured amount in zero-padded 12-digit format
pan	string	Masked card number. Returns XXXX when full PAN is not stored
expiry_date	string	Card expiry. Returns "/" when not stored with the original auth
epi	string	Merchant terminal / EPI identifier
channel	string	Transaction channel
token	string | null	Card token; null when not available for this capture type
card_brand	string | null	Card network; null when not available for this capture type
netamt	number	Net captured amount including fees

---

Response — 400 (Declined)

JSON

{
  "error_no": "E98",
  "error_code": "V5",
  "success_url": false,
  "txnid": "10333407",
  "batch_no": 211,
  "switch_error_code": "V0622",
  "mesg": "Capture/Ticket Transaction has already been performed",
  "desc": "Error code :V5",
  "msg": "Capture/Ticket Transaction has already been performed",
  "isFlexSendOrNot": "V0622"
}

Response fields

Field	Type	Description
error_no	string	E98 indicates a declined capture
error_code	string	Decline code (e.g. V5 = already captured)
success_url	boolean	Always false for declined operations
txnid	string	Transaction identifier
batch_no	integer	Settlement batch identifier
switch_error_code	string	Switch-level error code
mesg	string	Error message
msg	string	Error message
desc	string	Detailed error description
isFlexSendOrNot	string	Flex routing indicator; mirrors switch_error_code

---

Response — 400 (Processing Error)

JSON

{
  "error_no": "E16",
  "mesg": "PROCESSING ERROR",
  "msg": "PROCESSING ERROR",
  "desc": "INVALID TRAN NO"
}

Response fields

Field	Type	Description
error_no	string	E16 indicates the transaction number is invalid
mesg	string	Error message
msg	string	Error message
desc	string	Detailed description of the error cause

---

Error code reference

error_no	Meaning	Typical cause
S00	Approved	Capture successful
E98	Declined	Capture already performed on this transaction
E16	Processing error	Invalid or unrecognised transaction number (tran_no)

---

Void API

Void an unsettled transaction to prevent it from being settled.

---

Response — 200 OK (Approved)

JSON

{
  "error_no": "S00",
  "error_code": "00",
  "amount": "10.00",
  "tax": "0",
  "customfee": "0",
  "msg": "APPROVED",
  "txnid": "10333425",
  "desc": "APPROVAL TAS905",
  "additional_info": null,
  "epi": "2319916062",
  "channel": "ECOMM",
  "created_date": "28/04/2026",
  "created_time": "06:02:37",
  "rrn": "611810502972"
}

Response fields

Field	Type	Description
error_no	string	S00 indicates the void was successful
error_code	string	Gateway error code. 00 = no error
amount	string	Amount of the voided transaction
tax	string	Tax amount on the voided transaction
customfee	string	Custom fee on the voided transaction
msg	string	Result (e.g. APPROVED)
txnid	string	Transaction identifier of the void
desc	string	Detailed description including the approval code
additional_info	string | null	Reserved for additional metadata
epi	string	Merchant terminal / EPI identifier
channel	string	Transaction channel
created_date	string	Void date in DD/MM/YYYY format
created_time	string	Void time in HH:MM:SS format
rrn	string	Retrieval reference number

---

Response — 400 (Declined)

JSON

{
  "error_no": "E98",
  "error_code": "12",
  "success_url": false,
  "txnid": "10333419",
  "batch_no": 211,
  "switch_error_code": "V0543",
  "mesg": "Original transaction not found",
  "desc": "Error code :12",
  "msg": "Original transaction not found",
  "isFlexSendOrNot": "V0543"
}

Response fields

Field	Type	Description
error_no	string	E98 indicates a declined void
error_code	string	Decline code (e.g. 12 = original transaction not found)
success_url	boolean	Always false for declined operations
txnid	string	Transaction identifier
batch_no	integer	Settlement batch identifier
switch_error_code	string	Switch-level error code
mesg	string	Error message
msg	string	Error message
desc	string	Detailed error description
isFlexSendOrNot	string	Flex routing indicator; mirrors switch_error_code

---

Response — 400 (Processing Error)

JSON

{
  "error_no": "E17",
  "mesg": "PROCESSING ERROR",
  "msg": "PROCESSING ERROR",
  "desc": "INVALID RRN"
}

Response fields

Field	Type	Description
error_no	string	E17 indicates the RRN is invalid
mesg	string	Error message
msg	string	Error message
desc	string	Detailed description of the error cause

---

Error code reference

error_no	Meaning	Typical cause
S00	Approved	Transaction voided successfully
E98	Declined	Original transaction not found or already settled
E17	Processing error	RRN (retrieval reference number) is invalid

---

2FA Request

Initiate a two-factor authentication (2FA) challenge for a sensitive operation such as a refund. The customer will receive a verification code by email or SMS.

---

Response — 200 OK

JSON

{
  "status": 1,
  "error_code": "S00",
  "error_desc": "Success",
  "response": {
    "uuid": "nP4Pq*******GVnoTBt",
    "epi_id": "2203082193",
    "action": "ecomm_refund",
    "is_enable_2fa": 1,
    "reference_no": "4515201248",
    "emailId": "test********.com",
    "phoneNumber": "******2164",
    "operator mailId": "",
    "operator phoneNo": "",
    "expire_on": "2026-04-28 10:05:21",
    "created_on": "2026-04-28 10:03:21"
  }
}

Response fields — top level

Field	Type	Description
status	integer	1 on success
error_code	string	S00 indicates the 2FA challenge was issued successfully
error_desc	string	Success on success
response	object	2FA challenge details (see below)

response object fields

Field	Type	Description
uuid	string	Partially masked unique identifier for this 2FA session. Required when submitting the verification code
epi_id	string	Terminal EPI identifier associated with the action
action	string	The action requiring 2FA verification (e.g. ecomm_refund)
is_enable_2fa	integer	1 if 2FA is enabled for this terminal/action
reference_no	string	Reference number for this 2FA session
emailId	string	Partially masked email address the verification code was sent to
phoneNumber	string	Partially masked phone number the verification code was sent to
operator mailId	string	Operator email, if applicable
operator phoneNo	string	Operator phone number, if applicable
expire_on	string	Timestamp when the 2FA code will expire in YYYY-MM-DD HH:MM:SS format
created_on	string	Timestamp when the 2FA challenge was created in YYYY-MM-DD HH:MM:SS format

---

Response — 400 (Processing Error)

JSON

{
  "error_no": "E26",
  "mesg": "PROCESSING ERROR",
  "msg": "PROCESSING ERROR",
  "desc": "AUTHENTICATION FAILED"
}

Response fields

Field	Type	Description
error_no	string	E26 indicates an authentication failure
mesg	string	Error message
msg	string	Error message
desc	string	Detailed description of the error cause

---

Error code reference

error_code / error_no	Meaning	Typical cause
S00	Success	2FA challenge issued
E26	Processing error	Authentication credentials are invalid

---

Refund API

Issue a refund against a previously processed transaction.

---

Response — 200 OK (Approved)

JSON

{
  "error_no": "S00",
  "error_code": "00",
  "amount": "100.00",
  "tax": "",
  "customfee": "",
  "msg": "APPROVED",
  "txnid": "10333452",
  "desc": "APPROVAL TAS264",
  "additional_info": null,
  "epi": "2319916062",
  "channel": "VT",
  "created_date": "28/04/2026",
  "created_time": "06:08:27",
  "rrn": "611810500407"
}

Response fields

Field	Type	Description
error_no	string	S00 indicates a successful refund
error_code	string	Gateway error code. 00 = no error
amount	string	Refunded amount in decimal format
tax	string	Tax amount, if applicable
customfee	string	Custom fee, if applicable
msg	string	Result (e.g. APPROVED)
txnid	string	Unique transaction identifier for the refund
desc	string	Detailed description including the approval code
additional_info	string | null	Reserved for additional metadata
epi	string	Merchant terminal / EPI identifier
channel	string	Transaction channel
created_date	string	Refund date in DD/MM/YYYY format
created_time	string	Refund time in HH:MM:SS format
rrn	string	Retrieval reference number for reconciliation

---

Response — 400 (Declined)

JSON

{
  "error_no": "E98",
  "error_code": "54",
  "success_url": false,
  "txnid": "10333440",
  "batch_no": 846,
  "switch_error_code": "V0548",
  "mesg": "Card expired",
  "desc": "Error code :54",
  "msg": "Card expired",
  "isFlexSendOrNot": "V0548"
}

Response fields

Field	Type	Description
error_no	string	E98 indicates a declined refund
error_code	string	Decline code (e.g. 54 = card expired)
success_url	boolean	Always false for declined transactions
txnid	string	Transaction identifier assigned to the failed refund attempt
batch_no	integer	Settlement batch identifier
switch_error_code	string	Switch-level error code
mesg	string	Error message
msg	string	Error message
desc	string	Detailed error description
isFlexSendOrNot	string	Flex routing indicator; mirrors switch_error_code

---

Response — 400 (Processing Error)

JSON

{
  "error_no": "E26",
  "mesg": "PROCESSING ERROR",
  "msg": "PROCESSING ERROR",
  "desc": "AUTHENTICATION FAILED"
}

Response fields

Field	Type	Description
error_no	string	E26 indicates an authentication failure
mesg	string	Error message
msg	string	Error message
desc	string	Detailed description of the error cause

---

Error code reference

error_no	Meaning	Typical cause
S00	Approved	Refund processed successfully
E98	Declined	Card expired or original transaction cannot be refunded
E26	Processing error	Authentication credentials are invalid

---

Settlement API

Settle all open transactions in the current batch for a given terminal.

---

Response — 200 OK (Settled)

JSON

{
  "error_no": "S00",
  "error_code": "00",
  "amount": "88.87",
  "tax": "0.00",
  "customfee": "0.34",
  "msg": "APPROVED",
  "txnid": null,
  "desc": null,
  "additional_info": null,
  "epi": "2319916062",
  "channel": "VT",
  "created_date": "28/04/2026",
  "created_time": "06:09:35",
  "rrn": null
}

Response fields

Field	Type	Description
error_no	string	S00 indicates the settlement request was accepted
error_code	string	Gateway error code. 00 = no error
amount	string	Total settled amount in decimal format. "0.00" for an empty batch
tax	string	Total tax amount settled
customfee	string	Total custom fees settled
msg	string	Result (e.g. APPROVED)
txnid	string | null	Not applicable for settlement; always null
desc	string | null	Not applicable for settlement; always null
additional_info	string | null	"Empty Batch" when no transactions were present; otherwise null
epi	string	Merchant terminal / EPI identifier
channel	string	Transaction channel
created_date	string	Settlement date in DD/MM/YYYY format
created_time	string	Settlement time in HH:MM:SS format
rrn	string | null	Not applicable for settlement; always null

---

Response — 400 (Processing Error)

JSON

{
  "error_no": "E26",
  "mesg": "PROCESSING ERROR",
  "msg": "PROCESSING ERROR",
  "desc": "AUTHENTICATION FAILED"
}

Response fields

Field	Type	Description
error_no	string	E26 indicates an authentication failure
mesg	string	Error message
msg	string	Error message
desc	string	Detailed description of the error cause

---

Error code reference

error_no	Meaning	Typical cause
S00	Approved	Batch settled (or empty batch acknowledged)
E26	Processing error	Authentication credentials are invalid

Note: Both a successful settlement and an empty batch return error_no: "S00". Check additional_info for the value "Empty Batch" to distinguish the two cases.

---

List Subscription API

Retrieve a list of recurring subscriptions associated with a terminal.

---

Response — 200 OK

JSON

{
  "records": [
    {
      "subscription_id": "18262",
      "amount": "100",
      "custom_fee": "3.0000",
      "tax": "3.5000",
      "invoice_number": "12345678",
      "product_description": "Product 1",
      "shipping_customer_name": "John Doe",
      "shipping_street_no": "3636",
      "shipping_street_name": "33rd street",
      "shipping_unit": "206",
      "shipping_city": "ASTORIA",
      "shipping_state": "NY - New York",
      "shipping_zipcode": "11106",
      "billing_customerName": "John Doe",
      "billing_street_no": "3636",
      "billing_street_name": "33rd street",
      "billing_unit": "206",
      "billing_city": "ASTORIA",
      "billing_state": "NY - New York",
      "billing_zipcode": "11106",
      "subscription_day_of_the_month": "25",
      "subscription_starts_from": "2024-08-23",
      "subscription_valid_for": "6",
      "phone": "5478964785",
      "email": "jhon******.com",
      "no_of_failed_attempts": "0",
      "status": "1",
      "card_number": "XXXX1111",
      "total_no_of_payments": "6",
      "forfeit": "0",
      "forfeit_date": null
    }
  ],
  "error_no": "S00",
  "error_code": "00"
}

Response fields — top level

Field	Type	Description
error_no	string	S00 indicates a successful response
error_code	string	Gateway error code. 00 = no error
records	array	Array of subscription objects

records — subscription object fields

Field	Type	Description
subscription_id	string	Unique subscription identifier
amount	string	Recurring charge amount in decimal format
custom_fee	string	Custom fee applied per billing cycle
tax	string	Tax amount applied per billing cycle
invoice_number	string	Invoice reference for the subscription
product_description	string	Description of the subscribed product or service
shipping_customer_name	string	Name on the shipping address
shipping_street_no	string	Shipping street number
shipping_street_name	string	Shipping street name
shipping_unit	string	Shipping unit or apartment number
shipping_city	string	Shipping city
shipping_state	string	Shipping state (with label, e.g. NY - New York)
shipping_zipcode	string	Shipping ZIP code
billing_customerName	string	Name on the billing address
billing_street_no	string	Billing street number
billing_street_name	string	Billing street name
billing_unit	string	Billing unit or apartment number
billing_city	string	Billing city
billing_state	string	Billing state (with label, e.g. NY - New York)
billing_zipcode	string	Billing ZIP code
subscription_day_of_the_month	string	Day of the month on which billing runs (e.g. 25)
subscription_starts_from	string	Subscription start date in YYYY-MM-DD format
subscription_valid_for	string	Number of billing cycles the subscription is valid for
phone	string	Customer phone number
email	string	Customer email address (may be partially masked)
no_of_failed_attempts	string	Number of failed billing attempts so far
status	string	Subscription status — 1 = active, 0 = inactive
card_number	string	Masked card number — last 4 digits shown (e.g. XXXX1111)
total_no_of_payments	string	Total number of billing cycles configured
forfeit	string	1 if the subscription has been forfeited; 0 otherwise
forfeit_date	string | null	Date the subscription was forfeited; null if not forfeited

---

Response — 400 (Processing Error)

JSON

{
  "error_no": "E32",
  "mesg": "PROCESSING ERROR",
  "msg": "PROCESSING ERROR",
  "desc": "ACTIVE SEARCH FLAG IS MISSING"
}

Response fields

Field	Type	Description
error_no	string	E32 indicates a missing required filter parameter
mesg	string	Error message
msg	string	Error message
desc	string	Detailed description of the error cause

---

Error code reference

error_no	Meaning	Typical cause
S00	Success	Subscription records returned
E32	Processing error	Required active_search_flag parameter is missing from the request